API.md

Table of Contents

• OsmoseRequest
  • Parameters
  • language
  • endpoint
  • fetchErrors
    • Parameters
  • fetchError
    • Parameters
  • closeError
    • Parameters
  • falseError
    • Parameters
  • fetchSupportedCountries
  • fetchItemCategories
  • fetchItems
    • Parameters
• fetchErrorsRequest
  • Parameters
• fetchErrorRequest
  • Parameters
• closeErrorRequest
  • Parameters
• falseErrorRequest
  • Parameters
• fetchSupportedCountriesRequest
  • Parameters
• fetchItemCategoriesRequest
  • Parameters
• fetchItemsRequest
  • Parameters

OsmoseRequest

Osmose API request handler

Type: Object

Parameters

• options Object? Custom options to apply

language

Return the language to use for the Accept-language header of the requests

Returns string Language code (eg: fr, en, ru)

endpoint

Return the API endpoint to use for the requests

Returns string URL of the API endpoint

fetchErrors

Return an errors list

Parameters

• params Object

Returns Array

fetchError

Return all the informations about a specific error

Parameters

• errorId string The error ID

Returns Object

closeError

Mark the specific error as solved

Parameters

• errorId string The error ID

Returns Object

falseError

Mark the specific error as false positive

Parameters

• errorId string The error ID

Returns Object

fetchSupportedCountries

Return the list of the countries supported in the Osmose instance

Returns Array

fetchItemCategories

Return the list of the item categories with some details

Returns Array

fetchItems

Return the list of the items configured in the Osmose instance and their translated name. It's possible to filter the returned translations to one language.

Parameters

• isoCountryCode string? Eg: fr, en, ru

Returns Array

fetchErrorsRequest

Parameters

• endpoint string The API endpoint
• language string Accept-Language HTTP header value
• params Object

Returns Object

fetchErrorRequest

Parameters

• endpoint string The API endpoint
• language string Accept-Language HTTP header value
• errorId string The ID of the error to fetch

Returns Object

closeErrorRequest

Parameters

• endpoint string The API endpoint
• language string Accept-Language HTTP header value
• errorId string The ID of the error to mark as closed

Returns Object

falseErrorRequest

Parameters

• endpoint string The API endpoint
• language string Accept-Language HTTP header value
• errorId string The ID of the error to mark as false positive

Returns Object

fetchSupportedCountriesRequest

Parameters

• endpoint string The API endpoint
• language string Accept-Language HTTP header value

Returns Object

fetchItemCategoriesRequest

Parameters

• endpoint string The API endpoint
• language string Accept-Language HTTP header value

Returns Object

fetchItemsRequest

Parameters

• endpoint string The API endpoint
• language string Accept-Language HTTP header value

Returns Object