Árvore de páginas

Versões comparadas

Chave

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

...

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