Skip to content

PIM Service

Adnan Basar edited this page Apr 29, 2021 · 4 revisions

RBS Notification Service


Actions:

  • rbs.pimproduct.request.GET_PRODUCTS
const input = {
    scanAll?: boolean // default: false
    limit?: number, //default: 50 #per-page
    startIndex?: string // default: undefined
}
const response =  {
    products: PimProduct[],
    nextStartIndex?: string // nextToken in order to retrieve next page
} 

Actions:

  • rbs.pimproduct.request.GENERATE_IMPORT_URL
const response = {
    url: string
}
  • rbs.pimproduct.request.LIST_IMPORTS
const response = Import[]
  • rbs.pimproduct.request.LIST_EXPORTS
const response =  ExportExecution[]
  • rbs.pimproduct.request.GET_ROLES
const response = Role[]
  • rbs.pimproduct.request.UPSERT_ROLE
const input =  Role
  • rbs.pimproduct.request.DELETE_ROLE
const input = {
    roleName: string
}

Models

const ExportExecution = {
    status: string,
    startDate: Date,
    stopDate: Date,
    url: string | null,
}

const Role = {
    roleName: string,
    canEdit: string[],
    canView: string[],
    canDelete: boolean? // default: false
}

const Import = {
    name: string,
    status: string, // uploaded, imported
    createdAt: number, // 
    isImported: boolean // default: false,
    success: string[],
    failure: string[]
}