Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...


[GET] /MarketClassifications

Parâmetros

Valor

Descrição

Tipo de dado

Tipo de parâmetro

Obrigatório

Description


Descrição

string

query

não

FatherID


Id pai

long

query

não

Type

1,2,3,4,5

Departament = 1
Session = 2
Group = 3
SubGroup = 4
Category = 5

integer

query

não

page


Página

integer

query

não

pageSize


Tamanho da página

integer

query


Saída

{
"total": 4697,
 "hasNext": false,
 "items": [
   {
     "ID": (integer) // chave primária,
     "FatherID": (integer), // id pai
     "Description":(string), // descrição
     "Type": (Enum) // Departament = 1 Session = 2 Group = 3 SubGroup = 4 Category = 5
   }
]
}



...


[GET] /MarketClassifications/{id}

Parâmetros

Valor

Descrição

Tipo de dado

Tipo de parâmetro

Obrigatório

Description



string

path

sim

Saída

{
 "ID": (integer), // Chave primária
 "FatherID": (integer), // id pai
 "Description": (string), // descriçãp
 "Type": (integer) // Departament = 1 Session = 2 Group = 3 SubGroup = 4 Category = 5
}

 

(RMS.RSV.CAD) Classificação de mercadológica

...

Classificação mercadológica

Valor

Descrição

Tipo de dado

Tipo de parâmetro

Obrigatório


Página da consulta

string

query

não


Tamanho da página

long

query

não

0,1,2

Tipo de status:            Não enviado = 0
Enviado = 1
Todos = 2

integer

query

não

integer

query

não

integer

query

saída: {
 "Type": 1,
 "Code": 100,
 "SuccessItens": {
   "total": 0,
   "hasNext": true,
   "items": [
     {
       "Linha": "string",
       "IdSgi": 0,
       "ParentIdSgi": 0,
       "IdRMS": "string",
       "ParentIdRMS": "string",
       "Nome": "string",
       "Descricao": "string",
       "IdExterno": 0,
       "ParentIdExterno": 0,
       "Url": "string",
       "EnviadoEcommerce": 0,
       "VisivelEcommerce": 0,
       "Ordem": 0,
       "Tipo": 1,
       "NomePai": "string"
     }
   ]
 }
}

[GET]  /GetMarketingClassificationByIdRMS/{id}

Parâmetros

Valor

Descrição

Tipo de dado

Tipo de parâmetro

Obrigatório

ID


Chave primária

string

path

sim

Saída

{

 "Type": 1,
 "Code": 100,
 "SuccessItens": {
   "total": 0,
   "hasNext": true,
   "items": [
     {
       "Linha": "string", // Sequência da classificação mercadologica
       "IdSgi": 0,
       "ParentIdSgi": 0,
       "IdRMS": "string",
       "ParentIdRMS": "string",
       "Nome": "string",
       "Descricao": "string",
       "IdExterno": 0,
       "ParentIdExterno": 0,
       "Url": "string",
       "EnviadoEcommerce": 0,
       "VisivelEcommerce": 0,
       "Ordem": 0,
       "Tipo": 1,
       "NomePai": "string"
     }
   ]
 },

 "SuccessItem": {
   "Linha": "string",
   "IdSgi": 0,
   "ParentIdSgi": 0,
   "IdRMS": "string",
   "ParentIdRMS": "string",
   "Nome": "string",
   "Descricao": "string",
   "IdExterno": 0,
   "ParentIdExterno": 0,
   "Url": "string",
   "EnviadoEcommerce": 0,
   "VisivelEcommerce": 0,
   "Ordem": 0,
   "Tipo": 1,
   "NomePai": "string"
 },
 "Error": {
   "code": 0,
   "message": "string",
   "detailedMessage": "string",
   "helpUrl": "string",
   "details": [
     {
       "code": 0,
       "message": "string",
       "detailedMessage": "string"
     }
   ]
 }
}


[GET] /GetMarketingClassificationAllSGI

Parâmetros

Valor

Descrição

Tipo de dado

Tipo de parâmetro

Obrigatório

page


número da página

integer

query

não

pageSize


total de registros por página

integer

query

não

Saída

{
 "Type": 1,
 "Code": 100,
 "SuccessItens": {
   "total": 0,
   "hasNext": true,
   "items": [
     {
       "Linha": "string",
       "IdSgi": 0,
       "ParentIdSgi": 0,
       "IdRMS": "string",
       "ParentIdRMS": "string",
       "Nome": "string",
       "Descricao": "string",
       "IdExterno": 0,
       "ParentIdExterno": 0,
       "Url": "string",
       "EnviadoEcommerce": 0,
       "VisivelEcommerce": 0,
       "Ordem": 0,
       "Tipo": 1,
       "NomePai": "string"
     }
   ]
 },
 "SuccessItem": {
   "Linha": "string",
   "IdSgi": 0,
   "ParentIdSgi": 0,
   "IdRMS": "string",
   "ParentIdRMS": "string",
   "Nome": "string",
   "Descricao": "string",
   "IdExterno": 0,
   "ParentIdExterno": 0,
   "Url": "string",
   "EnviadoEcommerce": 0,
   "VisivelEcommerce": 0,
   "Ordem": 0,
   "Tipo": 1,
   "NomePai": "string"
 },
 "Error": {
   "code": 0,
   "message": "string",
   "detailedMessage": "string",
   "helpUrl": "string",
   "details": [
     {
       "code": 0,
       "message": "string",
       "detailedMessage": "string"
     }
   ]
 }
}




[GET] / GetMarketingClassificationByIdSGI/{IdSgi}

Parâmetros

Valor

Descrição

Tipo de dado

Tipo de parâmetro

Obrigatório

IdSgi


Chave primária SGI

integer

query

não

Saída

{
 "Type": 1,
 "Code": 100,
 "SuccessItens": {
   "total": 0,
   "hasNext": true,
   "items": [
     {
       "Linha": "string",
       "IdSgi": 0,
       "ParentIdSgi": 0,
       "IdRMS": "string",
       "ParentIdRMS": "string",
       "Nome": "string",
       "Descricao": "string",
       "IdExterno": 0,
       "ParentIdExterno": 0,
       "Url": "string",
       "EnviadoEcommerce": 0,
       "VisivelEcommerce": 0,
       "Ordem": 0,
       "Tipo": 1,
       "NomePai": "string"
     }
   ]
 },
 "SuccessItem": {
   "Linha": "string",
   "IdSgi": 0,
   "ParentIdSgi": 0,
   "IdRMS": "string",
   "ParentIdRMS": "string",
   "Nome": "string",
   "Descricao": "string",
   "IdExterno": 0,
   "ParentIdExterno": 0,
   "Url": "string",
   "EnviadoEcommerce": 0,
   "VisivelEcommerce": 0,
   "Ordem": 0,
   "Tipo": 1,
   "NomePai": "string"
 },
 "Error": {
   "code": 0,
   "message": "string",
   "detailedMessage": "string",
   "helpUrl": "string",
   "details": [
     {
       "code": 0,
       "message": "string",
       "detailedMessage": "string"
     }
   ]
 }
}


[GET] /GetMarketingClassificationByNameSGI

Parâmetros

Valor

Descrição

Tipo de dado

Tipo de parâmetro

Obrigatório

name


Nome da classificação

string

query

não

Saída

{
 "Type": 1,
 "Code": 100,
 "SuccessItens": {
   "total": 0,
   "hasNext": true,
   "items": [
     {
       "Linha": "string",
       "IdSgi": 0,
       "ParentIdSgi": 0,
       "IdRMS": "string",
       "ParentIdRMS": "string",
       "Nome": "string",
       "Descricao": "string",
       "IdExterno": 0,
       "ParentIdExterno": 0,
       "Url": "string",
       "EnviadoEcommerce": 0,
       "VisivelEcommerce": 0,
       "Ordem": 0,
       "Tipo": 1,
       "NomePai": "string"
     }
   ]
 },
 "SuccessItem": {
   "Linha": "string",
   "IdSgi": 0,
   "ParentIdSgi": 0,
   "IdRMS": "string",
   "ParentIdRMS": "string",
   "Nome": "string",
   "Descricao": "string",
   "IdExterno": 0,
   "ParentIdExterno": 0,
   "Url": "string",
   "EnviadoEcommerce": 0,
   "VisivelEcommerce": 0,
   "Ordem": 0,
   "Tipo": 1,
   "NomePai": "string"
 },
 "Error": {
   "code": 0,
   "message": "string",
   "detailedMessage": "string",
   "helpUrl": "string",
   "details": [
     {
       "code": 0,
       "message": "string",
       "detailedMessage": "string"
     }
   ]
 }
}


[POST] /PostMarketingClassificationAll  


Campo

Tipo

Descrição

Linha

string

Linha sequencial

IdSgi

integer


ParentIdSgi

integer


IdRMS

string

ID no RMS

ParentIdRMS

string

ID pai

Nome

string

Nome da classificação

Descricao

string

Descrição

IdExterno

integer

ID do eCommerce

ParentIdExterno

integer

ID pai do eCommerce

Url

string

url do da classificação no ecommerce

EnviadoEcommerce

integer

Se o item foi enviado do eCommerce

VisivelEcommerce

integer

Se item é visivel no eCommerce

Ordem

integer

sequencial

Tipo

enum (interger)

Departamento = 1, Secao = 2, Grupo = 3, Subgrupo = 4, Categoria = 5 }

NomePai

string




(RMS.RSV.CAD) Produtos

...


[GET] /ProductsStockPrice

Parâmetros

Valor

Descrição

Tipo de dado

Tipo de parâmetro

Obrigatório

store


Loja

string

query

sim

initialLimit


Limite inicial

long

query

sim

finalLimit

1,2,3,4,5

Limite final

integer

query

sim

id


Página

integer

query

não

isSendInternet


Tamanho da página

integer

query

não

Saída

{
"total": 4697,
 "hasNext": false,
 "items": [
   {
     "ID": (integer) // chave primária,
     "FatherID": (integer), // id pai
     "Description":(string), // descrição
     "Type": (Enum) // Departament = 1 Session = 2 Group = 3 SubGroup = 4 Category = 5
   }
]
}



[GET] /ProductsErp

Parâmetros

Valor

Descrição

Tipo de dado

Tipo de parâmetro

Obrigatório

initialLimit


Limite inicial da paginação

string

path

não

finalLimit


Limite final da paginação



não

id


chave primária



não

isSendInternet


se foi enviado do eCommerce



não

Saída

{

 "total": 783,

 "hasNext": false,

 "items": [

   {

     "ID": (int) // chave primaria (opcional),

     "EAN": (long) // codigo EAN (opcional),

     "Description": (string) // Descrição,

     "SmallDescription": (string) // Descrição curta,

     "WebDescription":  (descrição do ecommerce) // Descrição curta,

     "BrandDescription": (string) // descrição da marca,

     "IsSendInternet": (boolean) // Se foi enviado do ecoomerce,

     "isVariant": (string) // se é um produto variante ("N" para não e "S" para sim,

     "MarketingClassification": (string) // classificação mercadologica,

     "Weight": (decimal) // peso,

     "Lenght"  (decimal) // tamanho,

     "Width": (decimal) // largura,

     "Height": (decimal) , // Comprimento,

     "EANs": (object), // Colegão de EANs e imagens do prodtudo (opcional),

     "Store": (int) //Filial,

     "StockQuantity": (int) // Quantidade de Estoque

     "PriceRetail": (decimal) //Preço de Varejo,

     "PriceWholesaled": (decimal) //Preço de Atacado

     "PriceOfferRetail": (decimal) //Preço de Oferta Varejo,

     "StartOfferRetail":  (DateTime) //Data Inicio Ofertas Varejo,

     "EndOfferRetail":  (DateTime) //Data Fim Ofertas Varejo

     "IDSGI": (string) //Id da catergoria no SGI,

     "definition1": (string) // Atributo para compor o conceito de variante,

     "definition2": (string) // Atributo para compor o conceito de variante,

     "definition1Values": (string) // Atributo para compor o conceito de variante,

     "definition1Value": (string) // Atributo para compor o conceito de variante,

     "definition2Values": (string) // Atributo para compor o conceito de variante,

     "definition2Value": (string) // Atributo para compor o conceito de variante,

   }

 ]

}

 


Pedido de vendas (RMS.RSV.CAD)

[POST] /SaleOrders  


Campo

Tipo

Descrição

ID

integer($int64)

Identificador único do pedido

SaleStoreID

integer($int32)

loja de venda, a qual gera o pedido.

OriginStoreID

integer($int32)

Loja de Origem, a qual efetua a baixa de estoque do produto.

SalesManID

integer($int32)

Código do Vendedor

IssueDate

string($date-time)

Data de Emissão do pedido.

CustomerID

integer($int32)

Código identificador do Cliente.

ScheduleID

integer($int32)

Código identificador da agenda.

DeliveryType

string Enum: [ Normal ]

Tipo do frete.

DeliveryTypeDescription

string

Descrição do Tipo do frete.

DeliveryPrice

number($double)

Valor total do frete do pedido.

DiscountValue

number($double)

Valor do desconto dado no pedido.

TotalPrice

number($double)

Preço total do pedido.

TotalPriceItems

number($double)

Preço total do pedido referente aos valores dos itens(Soma dos itens).

TotalPriceMargin

number($double)

Preço total da margem do pedido.

PaymentType

stringEnum:[ Cash, Credit ]

Tipo da Condição de pagamento.

PaymentTypeWeb

integer($int32)

Tipo da Condição de pagamento no Ciashop.

PaymentTypeDescriptionWeb

string

Descrição da Condição de pagamento no CiaShop.

Status

string Enum: [ Registered, Checking, Conferred, Canceled ]

Status do pedido.

WithdrawType

string Enum:[ WithdraW, Delivery ]

Tipo de retirada do pedido após faturamento.

Note

string

informações de observação do pedido.

Source

string

informações sobre a origem do pedido.

DiscountReason

integer($int32)

Motivo do desconto concedido no pedido

Addresses

Campo

Tipo


ID

string


SaleOrderID

integer($int64)

Id do pedido

PublicArea

string


Complement

string

Complemento

ZipCode

integer($int32)

CEP

District

string

Rua

City

string

Cidade

State

string

Estado

Note

string

Notas

Number

integer($int32)

Número

AreaCode

integer($int32)

Código de área

PhoneNumber

integer($int32)

Telefone

GPS

string


CityCode

integer($int32)

Código IBGE da cidade

Type

string Enum:[ Delivery, Billing ]

Tipo de endereço

Items

Campo

Tipo

Descrição

ID

string


SaleOrderID

integer($int64)

Identificador do pedido vinculado ao item.

ProductID

integer($int32)

Código identificador do produto RMS

EAN

integer($int64)

Código EAN do produto.

Discount

number($double)

Quantidade de desconto dado ao produto(se houver).

Quantity

number($double)

Quantidade de venda do produto no pedido.

UnitaryValue

number($double)

Valor de venda unitário do tipo do produto.

AmountValue

number($double)

Valor total do produto no pedido considerando o valor unitário vezes a quantidade.

DeliveryPrice

number($double)

Valor do frete do produto.

Note

string

Observação sobre o Produto

DiscountReason

integer($int32)

Motivo do desconto concedido ao item

PackageID

integer($int32)

Código Identificador do Embalagem produto do RMS



OrderNumber

integer($int32)

Número do pedido web

ShippingMethodId

integer($int32)

Id da transportadora