Orion API (1.0.0)

Download OpenAPI specification:Download

Product Catalog

getHello

Responses

check

Responses

Response samples

200
503

Content type

application/json

{"status": "ok",
"info": {"database": {"status": "up"
}
},
"error": { },
"details": {"database": {"status": "up"
}
}
}

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
provider	string The provider
brand	string The brand
merchant	string The merchant
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
	string or Array of strings The keywords as string separated by a comma. Also accepts an array of keywords.
merchantCategoryPath	string The merchant category path
locale	string The locale
displayName	string The display name
shortDescription	string The short description
longDescription	string The long description
url	string The url

Responses

Request samples

Payload

Content type

application/json

{"productCode": "f20194fd-cdff-4895-a583-7a8606568fff",
"name": "Awesome Steel Towels",
"universalProductCode": "43a2d202-606b-40f7-83a9-d6362444e4ff",
"providerProductCode": "e7c1b7f0-3e3d-4b4f-8b5b-2d2e3f0b1e4f",
"provider": "Google market place",
"brand": "Adidas",
"merchant": "Adidas",
"merchantProductCode": "Adidas-4415",
"mainImageUrl": "https://www.adidas.com/image/Adidas-4415",
"thumbnailImageUrl": "https://www.adidas.com/image/Adidas-4415-tumb",
"alternateImage1Url": "https://www.adidas.com/image/Adidas-4415-alt1",
"alternateImage2Url": "https://www.adias.com/image/Adidas-4415-alt2",
"alternateImage3Url": "https://www.adidas.com/image/Adidas-4415-alt3",
"alternateImage4Url": "https://www.adidas.com/image/Adidas-4415-alt4",
"country": "FRA",
"currency": "EUR",
"price": "1000",
"isInstock": "true",
"isPreorder": "true",
"keywords": "sport,running",
"merchantCategoryPath": "sport/",
"locale": "fr",
"displayName": "Adidas-441",
"shortDescription": "chaussure de course confortable",
"longDescription": "chaussure de course confortable pour les longues distances et les terrains difficiles",
"url": "https://www.adidas.com/Adidas-4415"
}

Response samples

201

Content type

application/json

{"productId": 1,
"productCode": "f20194fd-cdff-4895-a583-7a8606568fff",
"name": "Awesome Steel Towels",
"universalProductCode": "43a2d202-606b-40f7-83a9-d6362444e4ff",
"providerProductCode": "e7c1b7f0-3e3d-4b4f-8b5b-2d2e3f0b1e4f",
"provider": "Google market place",
"brand": "Adidas",
"merchant": "Adidas",
"merchantProductCode": "Adidas-4415",
"mainImageUrl": "https://www.adidas.com/image/Adidas-4415",
"thumbnailImageUrl": "https://www.adidas.com/image/Adidas-4415-tumb",
"alternateImage1Url": "https://www.adidas.com/image/Adidas-4415-alt1",
"alternateImage2Url": "https://www.adias.com/image/Adidas-4415-alt2",
"alternateImage3Url": "https://www.adidas.com/image/Adidas-4415-alt3",
"alternateImage4Url": "https://www.adidas.com/image/Adidas-4415-alt4",
"country": "FRA",
"currency": "EUR",
"price": 1000,
"isInstock": true,
"isPreorder": true,
"keywords": ["sport",
"running"
],
"merchantCategoryPath": "sport/",
"locale": "fr",
"displayName": "Adidas-441",
"shortDescription": "chaussure de course confortable",
"longDescription": "chaussure de course confortable pour les longues distances et les terrains difficiles",
"url": "https://www.adidas.com/Adidas-4415",
"lastUpdateDate": "20240731",
"ProductCategories": [{"id": 1,
"label": "Sport"
}
]
}

Get all products

Responses

Response samples

200

Content type

application/json

[{"productId": 1,
"productCode": "f20194fd-cdff-4895-a583-7a8606568fff",
"name": "Awesome Steel Towels",
"universalProductCode": "43a2d202-606b-40f7-83a9-d6362444e4ff",
"providerProductCode": "e7c1b7f0-3e3d-4b4f-8b5b-2d2e3f0b1e4f",
"provider": "Google market place",
"brand": "Adidas",
"merchant": "Adidas",
"merchantProductCode": "Adidas-4415",
"mainImageUrl": "https://www.adidas.com/image/Adidas-4415",
"thumbnailImageUrl": "https://www.adidas.com/image/Adidas-4415-tumb",
"alternateImage1Url": "https://www.adidas.com/image/Adidas-4415-alt1",
"alternateImage2Url": "https://www.adias.com/image/Adidas-4415-alt2",
"alternateImage3Url": "https://www.adidas.com/image/Adidas-4415-alt3",
"alternateImage4Url": "https://www.adidas.com/image/Adidas-4415-alt4",
"country": "FRA",
"currency": "EUR",
"price": 1000,
"isInstock": true,
"isPreorder": true,
"keywords": ["sport",
"running"
],
"merchantCategoryPath": "sport/",
"locale": "fr",
"displayName": "Adidas-441",
"shortDescription": "chaussure de course confortable",
"longDescription": "chaussure de course confortable pour les longues distances et les terrains difficiles",
"url": "https://www.adidas.com/Adidas-4415",
"lastUpdateDate": "20240731",
"ProductCategories": [{"id": 1,
"label": "Sport"
}
]
}
]

Get all products

Responses

Response samples

200

Content type

application/json

[{"productId": 1,
"productCode": "f20194fd-cdff-4895-a583-7a8606568fff",
"name": "Awesome Steel Towels",
"universalProductCode": "43a2d202-606b-40f7-83a9-d6362444e4ff",
"providerProductCode": "e7c1b7f0-3e3d-4b4f-8b5b-2d2e3f0b1e4f",
"provider": "Google market place",
"brand": "Adidas",
"merchant": "Adidas",
"merchantProductCode": "Adidas-4415",
"mainImageUrl": "https://www.adidas.com/image/Adidas-4415",
"thumbnailImageUrl": "https://www.adidas.com/image/Adidas-4415-tumb",
"alternateImage1Url": "https://www.adidas.com/image/Adidas-4415-alt1",
"alternateImage2Url": "https://www.adias.com/image/Adidas-4415-alt2",
"alternateImage3Url": "https://www.adidas.com/image/Adidas-4415-alt3",
"alternateImage4Url": "https://www.adidas.com/image/Adidas-4415-alt4",
"country": "FRA",
"currency": "EUR",
"price": 1000,
"isInstock": true,
"isPreorder": true,
"keywords": ["sport",
"running"
],
"merchantCategoryPath": "sport/",
"locale": "fr",
"displayName": "Adidas-441",
"shortDescription": "chaussure de course confortable",
"longDescription": "chaussure de course confortable pour les longues distances et les terrains difficiles",
"url": "https://www.adidas.com/Adidas-4415",
"lastUpdateDate": "20240731",
"ProductCategories": [{"id": 1,
"label": "Sport"
}
]
}
]

Get all brands

Responses

Response samples

200

Content type

application/json

["string"
]

Get product

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

{"productId": 1,
"productCode": "f20194fd-cdff-4895-a583-7a8606568fff",
"name": "Awesome Steel Towels",
"universalProductCode": "43a2d202-606b-40f7-83a9-d6362444e4ff",
"providerProductCode": "e7c1b7f0-3e3d-4b4f-8b5b-2d2e3f0b1e4f",
"provider": "Google market place",
"brand": "Adidas",
"merchant": "Adidas",
"merchantProductCode": "Adidas-4415",
"mainImageUrl": "https://www.adidas.com/image/Adidas-4415",
"thumbnailImageUrl": "https://www.adidas.com/image/Adidas-4415-tumb",
"alternateImage1Url": "https://www.adidas.com/image/Adidas-4415-alt1",
"alternateImage2Url": "https://www.adias.com/image/Adidas-4415-alt2",
"alternateImage3Url": "https://www.adidas.com/image/Adidas-4415-alt3",
"alternateImage4Url": "https://www.adidas.com/image/Adidas-4415-alt4",
"country": "FRA",
"currency": "EUR",
"price": 1000,
"isInstock": true,
"isPreorder": true,
"keywords": ["sport",
"running"
],
"merchantCategoryPath": "sport/",
"locale": "fr",
"displayName": "Adidas-441",
"shortDescription": "chaussure de course confortable",
"longDescription": "chaussure de course confortable pour les longues distances et les terrains difficiles",
"url": "https://www.adidas.com/Adidas-4415",
"lastUpdateDate": "20240731",
"ProductCategories": [{"id": 1,
"label": "Sport"
}
]
}

Update product

path Parameters

id

required

number

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
provider	string The provider
brand	string The brand
merchant	string The merchant
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
	string or Array of strings The keywords as string separated by a comma. Also accepts an array of keywords.
merchantCategoryPath	string The merchant category path
locale	string The locale
displayName	string The display name
shortDescription	string The short description
longDescription	string The long description
url	string The url

Responses

Request samples

Payload

Content type

application/json

{"productCode": "f20194fd-cdff-4895-a583-7a8606568fff",
"name": "Awesome Steel Towels",
"universalProductCode": "43a2d202-606b-40f7-83a9-d6362444e4ff",
"providerProductCode": "e7c1b7f0-3e3d-4b4f-8b5b-2d2e3f0b1e4f",
"provider": "Google market place",
"brand": "Adidas",
"merchant": "Adidas",
"merchantProductCode": "Adidas-4415",
"mainImageUrl": "https://www.adidas.com/image/Adidas-4415",
"thumbnailImageUrl": "https://www.adidas.com/image/Adidas-4415-tumb",
"alternateImage1Url": "https://www.adidas.com/image/Adidas-4415-alt1",
"alternateImage2Url": "https://www.adias.com/image/Adidas-4415-alt2",
"alternateImage3Url": "https://www.adidas.com/image/Adidas-4415-alt3",
"alternateImage4Url": "https://www.adidas.com/image/Adidas-4415-alt4",
"country": "FRA",
"currency": "EUR",
"price": "1000",
"isInstock": "true",
"isPreorder": "true",
"keywords": "sport,running",
"merchantCategoryPath": "sport/",
"locale": "fr",
"displayName": "Adidas-441",
"shortDescription": "chaussure de course confortable",
"longDescription": "chaussure de course confortable pour les longues distances et les terrains difficiles",
"url": "https://www.adidas.com/Adidas-4415"
}

Response samples

200

Content type

application/json

{"productId": 1,
"productCode": "f20194fd-cdff-4895-a583-7a8606568fff",
"name": "Awesome Steel Towels",
"universalProductCode": "43a2d202-606b-40f7-83a9-d6362444e4ff",
"providerProductCode": "e7c1b7f0-3e3d-4b4f-8b5b-2d2e3f0b1e4f",
"provider": "Google market place",
"brand": "Adidas",
"merchant": "Adidas",
"merchantProductCode": "Adidas-4415",
"mainImageUrl": "https://www.adidas.com/image/Adidas-4415",
"thumbnailImageUrl": "https://www.adidas.com/image/Adidas-4415-tumb",
"alternateImage1Url": "https://www.adidas.com/image/Adidas-4415-alt1",
"alternateImage2Url": "https://www.adias.com/image/Adidas-4415-alt2",
"alternateImage3Url": "https://www.adidas.com/image/Adidas-4415-alt3",
"alternateImage4Url": "https://www.adidas.com/image/Adidas-4415-alt4",
"country": "FRA",
"currency": "EUR",
"price": 1000,
"isInstock": true,
"isPreorder": true,
"keywords": ["sport",
"running"
],
"merchantCategoryPath": "sport/",
"locale": "fr",
"displayName": "Adidas-441",
"shortDescription": "chaussure de course confortable",
"longDescription": "chaussure de course confortable pour les longues distances et les terrains difficiles",
"url": "https://www.adidas.com/Adidas-4415",
"lastUpdateDate": "20240731",
"ProductCategories": [{"id": 1,
"label": "Sport"
}
]
}

Remove product

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

{"productId": 1,
"productCode": "f20194fd-cdff-4895-a583-7a8606568fff",
"name": "Awesome Steel Towels",
"universalProductCode": "43a2d202-606b-40f7-83a9-d6362444e4ff",
"providerProductCode": "e7c1b7f0-3e3d-4b4f-8b5b-2d2e3f0b1e4f",
"provider": "Google market place",
"brand": "Adidas",
"merchant": "Adidas",
"merchantProductCode": "Adidas-4415",
"mainImageUrl": "https://www.adidas.com/image/Adidas-4415",
"thumbnailImageUrl": "https://www.adidas.com/image/Adidas-4415-tumb",
"alternateImage1Url": "https://www.adidas.com/image/Adidas-4415-alt1",
"alternateImage2Url": "https://www.adias.com/image/Adidas-4415-alt2",
"alternateImage3Url": "https://www.adidas.com/image/Adidas-4415-alt3",
"alternateImage4Url": "https://www.adidas.com/image/Adidas-4415-alt4",
"country": "FRA",
"currency": "EUR",
"price": 1000,
"isInstock": true,
"isPreorder": true,
"keywords": ["sport",
"running"
],
"merchantCategoryPath": "sport/",
"locale": "fr",
"displayName": "Adidas-441",
"shortDescription": "chaussure de course confortable",
"longDescription": "chaussure de course confortable pour les longues distances et les terrains difficiles",
"url": "https://www.adidas.com/Adidas-4415",
"lastUpdateDate": "20240731",
"ProductCategories": [{"id": 1,
"label": "Sport"
}
]
}

product-categories

List categories of a product

path Parameters

productId

required

number

Responses

Response samples

200

Content type

application/json

[{"productId": 0,
"categoryId": 0,
"lastUpdateDate": "2019-08-24T14:15:22Z"
}
]

List products of a category

path Parameters

categoryId

required

number

Responses

Response samples

200

Content type

application/json

[{"productId": 0,
"categoryId": 0,
"lastUpdateDate": "2019-08-24T14:15:22Z"
}
]

Add a product to a category

path Parameters

productId required	number
categoryId required	number

Responses

Remove a product from a category

path Parameters

productId required	number
categoryId required	number

Responses

Add a category to a product

path Parameters

categoryId required	number
productId required	number

Responses

Remove a category from a product

path Parameters

categoryId required	number
productId required	number

Responses

Create category

Request Body schema: application/json
required

label required	string The label of the category
parent	number The parent category id

Responses

Request samples

Payload

Content type

application/json

{"label": "chaussure",
"parent": 3
}

Response samples

201

Content type

application/json

{"categoryId": 1,
"lastUpdateDate": "2024-08-01T10:04:00.000Z",
"label": "chaussure",
"parent": 3
}

Get all categories

Responses

Response samples

200

Content type

application/json

[{"categoryId": 1,
"lastUpdateDate": "2024-08-01T10:04:00.000Z",
"label": "chaussure",
"parent": 3
}
]

Get category

path Parameters

id

required

number

Responses

Response samples

200

Content type

application/json

{"categoryId": 1,
"lastUpdateDate": "2024-08-01T10:04:00.000Z",
"label": "chaussure",
"parent": 3
}

Update category

path Parameters

id

required

number

Request Body schema: application/json
required

label required	string The label of the category
parent	number The parent category id

Responses

Request samples

Payload

Content type

application/json

{"label": "chaussure",
"parent": 3
}

Response samples

200

Content type

application/json

{"categoryId": 1,
"lastUpdateDate": "2024-08-01T10:04:00.000Z",
"label": "chaussure",
"parent": 3
}

Delete category

path Parameters

id

required

number

Orion API (1.0.0)

getHello

Responses

check

Responses

Response samples

products

Create product

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get all products

Responses

Response samples

Get all products

Responses

Response samples

Get all brands

Responses

Response samples

Get product

path Parameters

Responses

Response samples

Update product

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Remove product

path Parameters

Responses

Response samples

product-categories

List categories of a product

path Parameters

Responses

Response samples

List products of a category

path Parameters

Responses

Response samples

Add a product to a category

path Parameters

Responses

Remove a product from a category

path Parameters

Responses

Add a category to a product

path Parameters

Responses

Remove a category from a product

path Parameters

Responses

categories

Create category

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get all categories

Responses

Response samples

Get category

path Parameters

Responses

Response samples

Update category

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete category

path Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required