API docs by Redocly

Orion API (1.0.0)

Download OpenAPI specification:

Product Catalog

check

Responses

Response samples

Content type
application/json
{
  • "status": "ok",
  • "info": {
    },
  • "error": { },
  • "details": {
    }
}

products

Create product

Request Body schema: application/json
required
productCode
string

The product code

name
string

The name of the product

universalProductCode
string

The universal product code

providerProductCode
string

The provider product code

brand
string

The brand

merchantProductCode
string

The merchant product code

mainImageUrl
string

The main image url

thumbnailImageUrl
string

The thumbnail image url

alternateImage1Url
string

The alternate image 1 url

alternateImage2Url
string

The alternate image 2 url

alternateImage3Url
string

The alternate image 3 url

alternateImage4Url
string

The alternate image 4 url

country
string

The country

currency
string

The currency

number or string

The price

string or boolean

Is the product in stock

string or boolean

Is the product in preorder

keywords
string

The keywords

merchantCategory
string

The merchant category

merchantCategoryPath
string

The merchant category path

shortDescription
string

The short description

longDescription
string

The long description

color
string

The color

language
string

The language

url
string

The url

feedId
string

The feed id

isDiscontinued
boolean

Is the product discontinued

merchantId
required
string non-empty

The merchant ID

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Get all products

query Parameters
search_query
string

Free search, will apply on different field for each resource.

brand
string
Example: brand=Adidas

The brand

category
string <int64>
Example: category=1

The category id

merchant
string <int64>
Example: merchant=1

The merchant id

merchant_affiliation_status
string
Enum: "ACTIVE" "NOT_JOINED"
Example: merchant_affiliation_status=Active

The merchant affiliation status

price_min
number
Example: price_min=10

The minimum price

price_max
number
Example: price_max=100

The maximum price

status
string
Enum: "ONGOING" "COMPLETE"
Example: status=ONGOING

The product status

isPublished
string
Example: isPublished=true

The product publication status

offset
number >= 0

Offset for pagination.

limit
number >= 0

Limit for pagination.

sort
string

Sort for pagination.

Responses

Response samples

Content type
application/json
[]

Get all products

query Parameters
search_query
string

Free search, will apply on different field for each resource.

brand
string
Example: brand=Adidas

The brand

category
string <int64>
Example: category=1

The category id

merchant
string <int64>
Example: merchant=1

The merchant id

merchant_affiliation_status
string
Enum: "ACTIVE" "NOT_JOINED"
Example: merchant_affiliation_status=Active

The merchant affiliation status

price_min
number
Example: price_min=10

The minimum price

price_max
number
Example: price_max=100

The maximum price

status
string
Enum: "ONGOING" "COMPLETE"
Example: status=ONGOING

The product status

isPublished
string
Example: isPublished=true

The product publication status

offset
number >= 0

Offset for pagination.

limit
number >= 0

Limit for pagination.

sort
string

Sort for pagination.

Responses

Response samples

Content type
application/json
[]

Get all brands

query Parameters
search_query
string

Free search, will apply on different field for each resource.

offset
number >= 0

Offset for pagination.

limit
number >= 0

Limit for pagination.

sort
string

Sort for pagination.

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get product

path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{}

Update product

path Parameters
id
required
integer <int64>
Request Body schema: application/json
required
productCode
string

The product code

name
string

The name of the product

universalProductCode
string

The universal product code

providerProductCode
string

The provider product code

brand
string

The brand

merchantProductCode
string

The merchant product code

mainImageUrl
string

The main image url

thumbnailImageUrl
string

The thumbnail image url

alternateImage1Url
string

The alternate image 1 url

alternateImage2Url
string

The alternate image 2 url

alternateImage3Url
string

The alternate image 3 url

alternateImage4Url
string

The alternate image 4 url

country
string

The country

currency
string

The currency

number or string

The price

string or boolean

Is the product in stock

string or boolean

Is the product in preorder

keywords
string

The keywords

merchantCategory
string

The merchant category

merchantCategoryPath
string

The merchant category path

shortDescription
string

The short description

longDescription
string

The long description

color
string

The color

language
string

The language

url
string

The url

feedId
string

The feed id

isDiscontinued
boolean

Is the product discontinued

merchantId
string non-empty

The merchant Id

string or boolean

Is the product published

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Remove product

path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{}

product-categories

List categories of a product

path Parameters
productId
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List products of a category

path Parameters
categoryId
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a product to a category

path Parameters
productId
required
integer <int64>
categoryId
required
integer <int64>

Responses

Remove a product from a category

path Parameters
productId
required
integer <int64>
categoryId
required
integer <int64>

Responses

Add a category to a product

path Parameters
categoryId
required
integer <int64>
productId
required
integer <int64>

Responses

Remove a category from a product

path Parameters
categoryId
required
integer <int64>
productId
required
integer <int64>

Responses

categories

Create category

Request Body schema: application/json
required
label
required
string

The label of the category

parent
string <int64>

The parent category id

Responses

Request samples

Content type
application/json
{
  • "label": "chaussure",
  • "parent": 3
}

Response samples

Content type
application/json
{
  • "categoryId": 1,
  • "lastUpdateDate": "2024-08-01T10:04:00.000Z",
  • "label": "chaussure",
  • "parent": 3
}

Get all categories

query Parameters
search_query
string

Free search, will apply on different field for each resource.

offset
number >= 0

Offset for pagination.

limit
number >= 0

Limit for pagination.

sort
string

Sort for pagination.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get category path

path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get category

path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "categoryId": 1,
  • "lastUpdateDate": "2024-08-01T10:04:00.000Z",
  • "label": "chaussure",
  • "parent": 3
}

Update category

path Parameters
id
required
integer <int64>
Request Body schema: application/json
required
label
required
string

The label of the category

parent
string <int64>

The parent category id

Responses

Request samples

Content type
application/json
{
  • "label": "chaussure",
  • "parent": 3
}

Response samples

Content type
application/json
{
  • "categoryId": 1,
  • "lastUpdateDate": "2024-08-01T10:04:00.000Z",
  • "label": "chaussure",
  • "parent": 3
}

Delete category

path Parameters
id
required
integer <int64>

Responses

merchants

Create merchant

Request Body schema: application/json
required
name
string

The name of the merchant

region
string

The region of the merchant

vertical
string

The vertical of the merchant

description
string

The description of the merchant

mainImageUrl
string

The main image url

thumbnailImageUrl
string

The thumbnail image url

affiliationMembershipStatus
string
Enum: "ACTIVE" "NOT_JOINED"

The affiliation membership status

merchantId
required
string non-empty

The merchant id

providerId
string non-empty

The provider id

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Get all merchants

query Parameters
search_query
string

Free search, will apply on different field for each resource.

offset
number >= 0

Offset for pagination.

limit
number >= 0

Limit for pagination.

sort
string

Sort for pagination.

Responses

Response samples

Content type
application/json
[]

Get merchant by ID

path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{}

Update merchant by ID

path Parameters
id
required
integer <int64>
Request Body schema: application/json
required
name
string

The name of the merchant

region
string

The region of the merchant

vertical
string

The vertical of the merchant

description
string

The description of the merchant

mainImageUrl
string

The main image url

thumbnailImageUrl
string

The thumbnail image url

affiliationMembershipStatus
string
Enum: "ACTIVE" "NOT_JOINED"

The affiliation membership status

merchantId
required
string non-empty

The merchant id

providerId
string non-empty

The provider id

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Delete merchant by ID

path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{}

providers

Create provider

Request Body schema: application/json
required
name
string

the provider name

mainImageUrl
string

The main image url

thumbnailImageUrl
string

The thumbnail image url

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Get all providers

query Parameters
search_query
string

Free search, will apply on different field for each resource.

offset
number >= 0

Offset for pagination.

limit
number >= 0

Limit for pagination.

sort
string

Sort for pagination.

Responses

Response samples

Content type
application/json
[]

Get provider by ID

path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{}

Update provider by ID

path Parameters
id
required
integer <int64>
Request Body schema: application/json
required
name
string

the provider name

mainImageUrl
string

The main image url

thumbnailImageUrl
string

The thumbnail image url

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Delete provider by ID

path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{}