Ambiente URL Ambiente URL

Transcrição

1 GS1 Web Services Endpoints Ambiente Pré-Produção URL Produção Desenvolvimento (Media) Pré-Produção (Media) Produção (Media) Wsdl Ambiente Pré-Produção URL Produção Desenvolvimento (Media) Pré-Produção (Media) Produção (Media)

2 Métodos Nome CreateTradeItem CreateTradeItemList ExportItem ExportItemExcel GetGln GetGtin GetTradeItemListStatus SearchItems GetBricks GetEntities GetImageTypes GetMediasById Descrição Método para criar um novo item através de um ficheiro XML (CIN) passado como parâmetro. Indicando também se quer publicar ou não o item. Método para criar novos itens através de um ficheiro Excel. É possível republicar, atualizar e remover itens. Método para obter os detalhes completos do item no formato XML padrão GDSN. Método para obter os detalhes completos de vários itens num ficheiro Excel. Método para retornar o GLN associado a um determinado GTIN. Retorna o GLN e o nome do associado da GS1 respetivo. Caso um mesmo GTIN possa ser assignado a diferentes produtos de diferentes associados, o método retorna a lista de GLN e nomes de associados. Método para retornar GTINs de um associado. Este método funciona no sentido contrário do método acima: caso saiba o GLN de um associado, o método retorna a lista de materiais deste associado (só o GTIN e um descritivo). Método para retornar o estado de importação feita através do método CreateTradeItemList. Método para iniciar a pesquisa de itens, com base num conjunto de parâmetros de procura. É retornado um conjunto inicial de itens correspondentes aos parâmetros. Método para obter a LOV dos códigos Brick do GPC actual do Portal SyncPT. Método para obter a lista de entidades presentes no Portal. Método para obter a LOV dos tipos de imagem actual do Portal SyncPT Método para obter o ficheiro media atraves do seu ID interno SyncPT

3 GetMediasInfo QueryMedia UploadMedia Método para retornar uma lista com a informação dos medias que passem no filtro fornecido nos parametros. Método para ver informações sobre um Media dado o seu GTIN,GLN e nome do ficheiro. Método para fazer upload a um ficheiro Media para o SyncPT Tipos complexos Nome tns: CWSExportRequest Descrição Estrutura para garantir o critério para exportar informações do item tns: CWSItemData Estrutura que contém informações sobre o item tns: CWSItemDataCriterion Estrutura para garantir o critério para pesquisa de itens tns: CWSItemExportResponse Estrutura de resposta do método ExportItems e ExportItemExcel tns: CWSItemListResponse Estrutura de resposta do método SearchItems tns: CWSStatusResponse Estrutura de resposta para indicar estado da resposta. tns: GlnInfo Estrutura de resposta do método GetGln tns: GtinInfo Estrutura de resposta do método GetGtin tns: ImportCINResponse Estrutura de resposta do método CreateTradeItem tns: ImportExcelResponse Estrutura de resposta do método CreateTradeItemList tns: TradeItemStatus Estrututa de resposta do método GetTradeItemListStatus tns: ExportExcelRequest Estrutura passada como parâmetro do método ExportItemExcel

4 tns: MediaSOAFileInfo Estrutura de informação sobre um ficheiro media. tns: MediaSOAFile Estrutura com binário e informação de um ficheiro media. Notas 1. Endereço público para obtenção de binários (imagens) dos TradeItems: o

5 Método CreateTradeItem Descrição Método para criar um novo item através de um ficheiro XML (CIN) passado como parâmetro. Indicando também se quer publicar ou não o item. Input A entrada deste método tem vários argumentos, são eles: tns: Username xsd: string Identificação do utilizador que invoca o método tns: Password xsd: string Password do utilizador tns: Cin xsd: string Item a ser carregado na plataforma. Formato XML (CIN), padrão GDSN tns: IsToPublish xsd: boolean Flag para indicar publicação ou não do item Output A saída deste método é o argumento ImportResponse que possui a seguinte estrutura: tns: ImportResponse tns: ImportCINResponse Estrutura que contém o identificador do item que foi carregado na plataforma e o estado da resposta (ok, erro, etc..)

6 Método CreateTradeItemList Descrição Método para criar novos itens através de um ficheiro Excel. É possível republicar, atualizar e remover itens. Input A entrada deste método tem vários argumentos, são eles: tns: Username xsd: string Identificação do utilizador que invoca o método tns: Password xsd: string Password do utilizador tns: ExcelBinary xsd: Binary Data Itens a serem carregados na plataforma, em formato Excel tns: Filename xsd: string Nome do ficheiro Excel tns: RevertItemPublication xsd: boolean Flag para tornar os produtos editáveis ou não (caso já tenham sido carregados) tns: IsToPublish xsd: boolean Flag para indicar publicação ou não do item Output A saída deste método é o argumento ImportResponse que possui a seguinte estrutura: tns: ImportResponse tns: ImportExcelResponse Estrutura que contém um identificador do job assincrono (GUID) que foi carregado na plataforma e o estado da resposta (ok, erro, etc..). O GUID é usado para verificar estado do job (Método GetTradeItemListStatus)

7 Método ExportItem Descrição Obter os detalhes completos do item no formato XML do standard GDSN. Input A entrada deste método tem vários argumentos, são eles: tns: userid xsd: string Identificação do utilizador que invoca o método tns: password xsd: string Password do utilizador tns: exportparameters tns: CWSExportRequest Estrutura que contém os parâmetros de identificação para os itens a serem exportados Output A saída deste método é o argumento ExportItemResult que possui a seguinte estrutura: tns: ExportItemResult tns: CWSItemExportResponse Estrutura que contém o XML do standard GDSN num formato base64 codificado

8 Método ExportItemExcel Descrição Obter os detalhes completos de vários itens num ficheiro Excel. Input A entrada deste método tem vários argumentos, são eles: tns: Username xsd: string Identificação do utilizador que invoca o método tns: Password xsd: string Password do utilizador tns: ExportParameters tns: ExportExcelRequest Estrutura que contém os parâmetros de identificação para os itens a serem exportados Output A saída deste método é o argumento ExportItemResult que possui a seguinte estrutura: tns: ExportItemResult tns: CWSItemExportResponse Estrutura que contém o Excel (binário) num formato base64 codificado

9 Método GetGln Descrição Método para retornar o GLN associado a um determinado GTIN. Retorna o GLN e o nome do associado da GS1 respetivo. Caso um mesmo GTIN possa ser assignado a diferentes produtos de diferentes associados, o método retorna a lista de GLN e nomes de associados. Input A entrada deste método tem vários argumentos, são eles: tns: Username xsd: string Identificação do utilizador que invoca o método tns: Password xsd: string Password do utilizador tns: Gtin tns: string Código GTIN Output A saída deste método é o argumento GlnBasicInfo que contém a seguinte estrutura: tns: GlnBasicInfo tns: GlnInfo Estrutura de resposta do método GetGln

10 Método GetGtin Descrição Método para retornar GTINs de um associado. Este método funciona no sentido contrário do método acima: caso saiba o GLN de um associado, o método retorna a lista de materiais deste associado (só o GTIN e um descritivo). Input A entrada deste método tem vários argumentos, são eles: tns: Username xsd: string Identificação do utilizador que invoca o método tns: Password xsd: string Password do utilizador tns: Gln tns: string GLN que identifica a empresa que publicou a informação Output A saída deste método é o argumento GtinBasicInfo que contém a seguinte estrutura: tns: GtinBasicInfo tns: GtinInfo Estrutura de resposta do método GetGtin

11 Método GetTradeItemListStatus Descrição Retornar o estado de importação executada através do método CreateTradeItemList. Input A entrada deste método tem vários argumentos, são eles: tns: Username xsd: string Identificação do utilizador que invoca o método tns: Password xsd: string Password do utilizador tns: ImportGuid xsd: int Identificador do job assincrono (GUID) Output A saída deste método é o argumento StatusTradeItem que possui a seguinte estrutura: tns: StatusTradeItem tns: TradeItemStatus Estrutura que contém o status do job assincrono e o estado da resposta (ok, erro, etc..).

12 Método SearchItems Descrição Iniciar a pesquisa de itens, com base num conjunto de parâmetros de procura. É retornado um conjunto inicial de itens correspondentes aos parâmetros. Input A entrada deste método tem vários argumentos, são eles: tns: Username xsd: string Identificação do utilizador que invoca o método tns: Password xsd: string Password do utilizador tns: SearchParameters tns: CWSItemDataCriterion Estrutura de dados que define os parâmetros para a pesquisa; tns: RecordsPerPage tns: PagesToPresent (Deprecated) xsd: int Número de registos a serem apresentados por página. xsd: int Número de páginas calculadas pelo sistema antes do pedido. A primeira página é apresentada, as páginas restantes são calculadas em background Output A saída deste método é o argumento SearchItemsResult que possui a seguinte estrutura: tns: SearchItemsResult tns: CWSItemListResponse Lista de CWSItemData, que contém a página inicial de itens que correspondem ao critério

13

14 Método Getbricks Descrição Método para obter a LOV dos códigos Brick do GPC actual do Portal SyncPT. Input A entrada deste método tem apenas os elementos de autenticação no SyncPT, são eles: Username string Identificação do utilizador que invoca o método Password string Password do utilizador Output A saída deste método é o argumento CWSStatusResponse e a lista de bricks desejada: Status CWSStatusResponse Estrutura que contem a status da resposta a este pedido. BrickLOV List of GDSNBrick 0.. n Lista de códigos Brick GPC do portal SyncPT

15 Método GetEntities Descrição Método para obter a lista de entidades presentes no Portal. Input A entrada deste método tem os argumentos de autenticação no SyncPT e um parametro de modo: Username string Identificação do utilizador que invoca o método Password string Password do utilizador IsAllEntities boolean Indica se se quer uma lista de todas as entidades do SyncPT (true) ou apenas deste utilizador (false) Output A saída deste método é o argumento CWSStatusResponse e a lista de bricks desejada: Status CWSStatusResponse Estrutura que contem a status da resposta a este pedido. EntityList List of GDSNEntity 0.. n Lista de entidades conforme o filtro fornecido.

16 Método GetImageTypes Descrição Método para obter a LOV dos tipos de imagem actual do Portal SyncPT Input A entrada deste método é somente a autenticação no SyncPT: Username string Identificação do utilizador que invoca o método Password string Password do utilizador Output A saída deste método é o argumento ExportItemResult que possui a seguinte estrutura: Status CWSStatusResponse Estrutura que contem a status da resposta a este pedido. ImageTypeLOV List of MediaFileNature 0.. n Lista com os tipos de imagem presentes no portal SyncPT

17 Método GetMediasById Descrição Método para obter o ficheiro media atraves do seu ID interno SyncPT Input A entrada deste método consiste na autenticação e no id do media a retornar: Username string Identificação do utilizador que invoca o método Password string Password do utilizador MediaId Int (MediaId) Id interno SyncPT do Media. Output A saída deste método é o argumento GlnBasicInfo que contém a seguinte estrutura: Status CWSStatusResponse Estrutura que contem a status da resposta a este pedido. MediaSOAFile MediaSOAFile Estrutura com o binario e informação sobre o Media pretendidos.

18 Método GetMediasInfo Descrição Método para retornar uma lista com a informação dos medias que passem no filtro fornecido nos parametros. Input A entrada deste método tem vários argumentos, são eles: Username string Identificação do utilizador que invoca o método Password string Password do utilizador Brick GDSNBrick identifier (int) Filtro do Brick do GPC ProviderGLN string Filtro de GLN (esperada string tipo GLN) ProviderName (deprecated) string Filtro de nome da empresa ImageType MediaFileNature identifier (int) Filtro com o tipo de ficheiro Tag String Filtro com o tag. ModifyDate Date Filtro com a data da ultima modificação. Output A saída deste método é o argumento GtinBasicInfo que contém a seguinte estrutura: Status CWSStatusResponse Estrutura que contem a status da resposta a este pedido. ListOfMediaSOAFileInfo List of MediaSOAFileInfo 0.. n Lista de estruturas com a informação dos media que batem certo com o pedido.

19 Método QueryMedia Descrição Método para ver informações sobre um Media dado o seu GTIN,GLN e nome do ficheiro. Input A entrada deste método tem vários argumentos, são eles: Username string Identificação do utilizador que invoca o método Password string Password do utilizador GTIN string GTIN do produto a pesquisar GLN string GLN da entidade que publicou o produto Filename string Nome do ficheiro de media pretendido Output A saída deste método é o argumento StatusTradeItem que possui a seguinte estrutura: Status CWSStatusResponse Estrutura que contem a status da resposta a este pedido. FileSize int Tamanho do ficheiro encontrado em bytes (0 se não encontrado) LastChangeDateTime DateTime Quando é que este ficheiro teve a sua ultima modificação. (irrelevante se não encontado)

20 Método UploadMedia Descrição Método para fazer upload a um ficheiro Media para o SyncPT Input A entrada deste método tem vários argumentos, são eles: Username string Identificação do utilizador que invoca o método Password string Password do utilizador GTIN string GTIN do produto a pesquisar GLN string GLN da entidade que publicou o produto Binary Binary data O binário do ficheiro Filename string Nome do ficheiro de media pretendido IsReplace boolean Indica se o que se pretende é substituir um ficheiro já existente (true) ou criar sempre um novo (false) Fullpath string Argumento de echo para a notificação assincrona OverrideDateTime Datetime Data de escrita do ficheiro a ser inscrita no SyncPT Output A saída deste método é o argumento SearchItemsResult que possui a seguinte estrutura: Status CWSStatusResponse Estrutura que contem a status da resposta a este pedido. FullpathEcho string O argumento Fullpath de volta para notificação assincrona.

21 Tipo complexo CWSExportRequest Modelo de conteúdo Contém os elementos, tal como definido na seguinte tabela: Componente Tipo Ocorre Descrição tns: Gtin xsd: string O código GTIN tns: SubscriberGln xsd: string O GLN da empresa-alvo tns: SupplierGln xsd: string O GLN do fornecedor que publicou o item tns: TargetMarketCountryCode xsd: string Código do país, ISO , para o mercado-alvo tns: TargetMarketSubdivisionCode(Deprecated) xsd: string Código da Subdivisão, ISO Referenciado por Elemento tns: exportparameters [método ExportItem]

22 Tipo complexo CWSItemData Modelo de conteúdo Contém os elementos, tal como definido na seguinte tabela: Componente Tipo Ocorre Descrição tns: BrandName xsd: string Marca do item tns: EffectiveDate xsd: datetime Data Efectiva tns: Gpc xsd: string Código brick GPC tns: Gtin xsd: string Código GTIN tns: ItemDescription xsd: string Descrição do item tns: ItemName xsd: string Nome funcional do item tns: LastChangeDateTime xsd: datetime A data da última alteração das informações do item tns: PublicationStatus xsd: string O estado de publicação de informações tns: SearchInstance (Deprecaded) xsd: string Identifica cada instância de pesquisa. Utilizado como referência para obter as páginas seguintes. tns: SupplierGln xsd: string GLN que identifica a empresa que publicou a informação tns: SupplierName xsd: string O nome da empresa, que publicou a informação na datapool tns: TargetMarketCountryCode(Deprecaded) xsd: string Código do país, ISO , para o mercado-alvo

23 tns: TargetMarketSubdivisionCode(Deprecaded) xsd: string Código da Subdivisão, ISO tns: ishighestlevel (Deprecaded) xsd: boolean Indica se o item está no nível superior de uma hierarquia (uma palete por exemplo) tns: islowestlevel (Deprecaded) xsd: boolean Indica se o item está na parte inferior da hierarquia Referenciado por Elemento tns: CWSItemListResponse Elemento tns: itemlist (type Record List) [Elemento tns: CWSItemListResponse]

24 Tipo complexo CWSItemDataCriterion Modelo de conteúdo Contém os elementos, tal como definido na seguinte tabela: Componente Tipo Ocorre Descrição tns: BrandName xsd: string Marca do item tns: Gpc xsd: string Código brick GPC tns: Gtin xsd: string Código GTIN tns: ItemName xsd: string Nome funcional do item tns: LanguageCode xsd: string tns: Publicationstatus xsd: string O estado de publicação de informações tns: SupplierGln xsd: string GLN que identifica a empresa que publicou a informação tns: TargetMarketCountryCode xsd: string Código do país, ISO , para o mercado-alvo tns: TargetMarketSubdivisionCode(Deprecated) xsd: string Código da Subdivisão, ISO tns: TradeItemUnitDescriptor xsd: string Descritor do item (CASE,..) Referenciado por Elemento tns: searchparameters [método SearchItems]

25 Tipo complexo CWSItemExportResponse Modelo de conteúdo Contém os elementos, tal como definido na seguinte tabela: Componente Tipo Ocorre Descrição tns: Data xsd: base64string Documento XML codificado em Base64 tns: Status tns: CWSStatusResponse Solicitação de estado, pode ter indicação de erro; Referenciado por Elemento tns: ExportItemResult [método ExportItem] Elemento tns: ExportItemResult [método ExportItemExcel]

26 Tipo complexo CWSItemListResponse Modelo de conteúdo Contém os elementos, tal como definido na seguinte tabela: Componente Tipo Ocorre Descrição tns: itemlist tns: Record List [tns: CWSItemData] Matriz de estruturas que contêm detalhes de dados do item; tns: status tns: CWSStatusResponse Solicitação de estado, pode ter indicação de erro; Referenciado por Elemento tns: CWSItemListResponse Elemento tns: SearchItemsResult [método SearchItems]

27 Tipo complexo CWSStatusResponse Modelo de conteúdo Contém os elementos, tal como definido na seguinte tabela: Componente Tipo Ocorre Descrição tns: ErrorMessage xsd: string Mensagem que descreve o erro que ocorreu tns: StatusCode xsd: string Código de estado do pedido. Lista de valores possíveis: "GENERALERROR" - Especificado no erro da mensagem; "AUTHFAILED" - "User and/or password invalid and/or the user does not have the role publisher" ou "User and/or password invalid."; "ITEMNOTFOUND" - "The requested item could not be found or is not in the published state."; "FILEERROR" - "There was an error with the XML file (CIN)" ou "Errors found in the file."; "OK" - "Operation completed successfully"; Referenciado por Elemento tns: status [Elemento tns: CWSItemExportResponse] Elemento tns: status [Elemento tns: CWSItemListResponse] Elemento tns: Status [Elemento tns: ImportCINResponse] Elemento tns: Status [Elemento tns: ImportExcelReponse] Elemento tns: Status [Elemento tns: GlnInfo] Elemento tns: Status [Elemento tns: GtinInfo] Elemento tns: Status [Elemento tns: TradeItemStatus]

28 Tipo complexo GlnInfo Modelo de conteúdo Contém os elementos, tal como definido na seguinte tabela: Componente Tipo Ocorre Descrição tns: Status tns: CWSStatusResponse Solicitação de estado, pode ter indicação de erro tns: GlnBasicInfoList tns: Record List [tns: GlnBasicInfo] Lista com o nome e Gln do fornecedor de informação Referenciado por Elemento tns: GlnBasicInfo [método GetGln]

29 Tipo complexo GtinInfo Modelo de conteúdo Contém os elementos, tal como definido na seguinte tabela: Componente Tipo Ocorre Descrição tns: Status tns: CWSStatusResponse Solicitação de estado, pode ter indicação de erro tns: GtinBasicInfoList tns: Record List [tns: GtinBasicInfo] Lista com o descrição e Gtin do item Referenciado por Elemento tns: GtinBasicInfo [método GetGtin]

30 Tipo complexo ImportCINResponse Modelo de conteúdo Contém os elementos, tal como definido na seguinte tabela: Componente Tipo Ocorre Descrição tns: TradeItemId xsd: Int Identificador do item tns: Status tns: CWSStatusResponse Solicitação de estado, pode ter indicação de erro Referenciado por Elemento tns: ImportResponse [método CreateTradeItem]

31 Tipo complexo ImportExcelResponse Modelo de conteúdo Contém os elementos, tal como definido na seguinte tabela: Componente Tipo Ocorre Descrição tns: ImportGuid xsd: Int Identificador único do Job de importação de itens tns: ErrorList tns: Record List [tns: IntTextPair] Lista com os erros presentes no Excel tns: Status tns: CWSStatusResponse Solicitação de estado, pode ter indicação de erro Referenciado por Elemento tns: ImportResponse [método CreateTradeItemList]

32 Tipo complexo TradeItemStatus Modelo de conteúdo Contém os elementos, tal como definido na seguinte tabela: Componente Tipo Ocorre Descrição tns: StatusTradeItem xsd: String Estado do Job de importação tns: Status tns: CWSStatusResponse Solicitação de estado, pode ter indicação de erro Referenciado por Elemento tns: StatusTradeItem [método GetTradeItemListStatus]

33 Tipo complexo ExportExcelRequest Modelo de conteúdo Contém os elementos, tal como definido na seguinte tabela: Componente Tipo Ocorre Descrição tns: SubscriberGln xsd: String O GLN da empresaalvo tns: SupplierGln tns: String O GLN da empresa que publicou a informação tns: GtinList tns: Record List [xsd: String] Lista de Gtins a serem exportados Referenciado por Elemento tns: ExportParameters [método ExportItemExcel]

34 Tipo complexo MediaSOAFileInfo Modelo de conteúdo Contém os elementos, tal como definido na seguinte tabela: Componente Tipo Ocorre Descrição FileName string O nome do ficheiro GTIN string O GTIN do produto que tem este media. Brick string Vazio (Deprecated) SuplierGLN string O GLN do fornecedor do produto. (Deprecated) SuplierName string O nome do fornecedor do produto. (Deprecated) Tags String Vazio (Deprecated) LastModifyDate DateTime Data da ultima modificação do ficheiro no SyncPT. MediaId Media identifier(int) Identificador interno do media no SyncPT (0 para não encontrado) FileSize Int Tamanho do ficheiro em bytes. Referenciado por Elemento MediaSOAFile

35 Tipo complexo MediaSOAFile Modelo de conteúdo Contém os elementos, tal como definido na seguinte tabela: Componente Tipo Ocorre Descrição Binary Binary data O binário do ficheiro media. MediaSOAFileInfo MediaSOAFileInfo A informação do ficheiro. Referenciado por Elemento tns: ExportParameters [método ExportItemExcel]