Árvore de páginas

Versões comparadas

Chave

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

Objetivo

A finalidade deste método é possibilitar o cadastro de produtos, incluindo dados de códigos de acesso, e imagens de produtos.

Chamada

POST api/v3/products/product

Informações para

...

Requisição (Request Information)

Parâmetros

...

URI (URI Parameters)

Não há.

Parâmetros do

...

Corpo (Body Parameters)

PostProductDTO
Nome 
Nome (Name)
Descrição 
Descrição (Description)
Tipo 
Tipo (Type)Informações
Adicionais 
Adicionais (Adittional Information)
dataFamilyData to register a new family. Note: This field or seqFamily must be passed, necessarily. However, if both fields are passed, this field will be ignored and seqFamily will be the field consideredPostFamilyDTONão há.
seqFamilyFamily sequence Note: If this field is passed, the dataFamily field will be ignoredintegerNão há.
complementFamily description complementstringTamanho Máximo: 50
reducedDescriptionReduced descriptionstringTamanho Máximo: 24
manufacturingProcessIndicatorIndicates the process of manufacturing the product itself (S – No production process, B – Base product for breakdown, F – Composite end product, V – Variable composition product, I – Input for production, C – Compound for separation, M – Automatic movement) – (Default: S)stringTamanho Máximo: 1
genericDescriptionGeneric descriptionstringTamanho Máximo: 60
anpCodeANP CodeintegerNão há.
anpDescriptionDescription of the product according to ANPstringTamanho Máximo: 95
zeroBalancePriceIndicatorIndicator to generate zero price for scales (S – Yes / N – No) – (Default: N)stringTamanho Máximo: 1
productControlTemperatureIndicatorIndicates whether the product controls the temperature (S – Yes / N – No) – (Default: N)stringTamanho Máximo: 1
replicationIndicatorReplicação indicator (S – Yes / N – No) – (Default: S)stringTamanho Máximo: 1
issueTaxCodeInNFEIndicatorIndicator for issuing fiscal product code in NFE (S – Yes / N – No) – (Default: N)stringTamanho Máximo: 1
codesAccess codes listCollection of PostProductCodeDTONão há.
imagesImages listCollection of PostProductImageDTONão há.
PostProductCodeDTO
Nome (Name)
Descrição 
Descrição (Description)
Tipo 
Tipo (Type)Informações
Adicionais 
Adicionais (Adittional Information)
supplierCnpjSupplier’s CNPJ (Acceptable formats: 00.000.000/0001-00 or 00000000000000) – (Default: 0) Note: Must be informed when the codeTye field is ‘F’ or ‘C’stringTamanho Máximo: 18
seqNetworkNetwork sequence Note: Must be informed when the codeTye field is ‘L’integerNão há.
codeTypeType of access code (A – AFV, C – Client, D – DUN, E – EAN/Barcode, F – Supplier, B – Internal, L – Customer network, I – Transition)stringObrigatório


Tamanho Máximo: 1

packingQuantityPacking quantitydecimal numberNão há.
accessCodeAccess codestringObrigatório


Tamanho Máximo: 60

usageForSaleIndicatorUsage for sale indicator – (Default: S)stringTamanho Máximo: 1
EANTaxableNFEIndicatorEAN taxable NFE indicator – (Default: N)stringTamanho Máximo: 1
usageForNFEIndicatorUsage FOR NFE Indicator – (Default: S)stringTamanho Máximo: 1
PostProductImageDTO
Nome 
Nome (Name)
Descrição 
Descrição (Description)
Tipo 
Tipo (Type)Informações
Adicionais 
Adicionais (Adittional Information)
descriptionDescription for the imagestringObrigatório


Tamanho Máximo: 40

imageImage in Base64. Valid Extensions: bmp, jpg, gif, png, tif, tiffstringObrigatório
mainIndicatorMain Image Indicator (Options: S – Yes / N – No) – (Default: S)stringTamanho Máximo: 1
pictureLayoutImage Layout (Options: F – Front, V – Verse, L – Side) – (Default: F)stringTamanho Máximo: 1

Formatos da

...

Requisição (Request Formats)

application/json, text/json

Exemplo Exemplo (Sample):

{
  "dataFamily": {
    "family": "sample string 1",
    "weighable": "sample string 2",
    "allowsDecimal": "sample string 3",
    "seqBrand": 1,
    "containerIndicator": "sample string 4",
    "allowsMultiplication": "sample string 5",
    "usesStockBatchIndicator": "sample string 6",
    "ipiAliquot": 1.1,
    "nfPisSituation": "sample string 7",
    "nfCofinsSituation": "sample string 8",
    "nfPisLeaveSituation": "sample string 9",
    "nfCofinsLeaveSituation": "sample string 10",
    "nbmshCode": "sample string 11",
    "cestCode": 1,
    "percentageImportTax": 1.1,
    "revenueIndicator": "sample string 12",
    "similarIndicator": "sample string 13",
    "replicationIndicator": "sample string 14",
    "revenueType": 1,
    "taxationPisCofinsIndicator": "sample string 15",
    "pisCofinsSimpleSituation": "sample string 16",
    "packaging": [
      {
        "packingQuantity": 1.1,
        "packing": "sample string 1",
        "grossWeight": 1.1,
        "netWeight": 1.1,
        "heigh": 1.0,
        "width": 1.0,
        "depth": 1.0,
        "status": "sample string 2",
        "packingUnitQuantity": 1.0,
        "packingWeight": "sample string 3",
        "replicationIndicator": "sample string 4",
        "liters": 1.1,
        "usesLabelProductBatch": "sample string 5",
        "priceKindPacking": "sample string 6",
        "decimalPacking": "sample string 7"
      },
      {
        "packingQuantity": 1.1,
        "packing": "sample string 1",
        "grossWeight": 1.1,
        "netWeight": 1.1,
        "heigh": 1.0,
        "width": 1.0,
        "depth": 1.0,
        "status": "sample string 2",
        "packingUnitQuantity": 1.0,
        "packingWeight": "sample string 3",
        "replicationIndicator": "sample string 4",
        "liters": 1.1,
        "usesLabelProductBatch": "sample string 5",
        "priceKindPacking": "sample string 6",
        "decimalPacking": "sample string 7"
      }
    ],
    "suppliers": [
      {
        "cnpj": "sample string 1",
        "mainSupplier": "sample string 2",
        "replicationIndicator": "sample string 3",
        "calculatesDiscountSuframaforPisCofins": "sample string 4",
        "ipiCollectionIndicator": "sample string 5",
        "mainControlIndicator": "sample string 6"
      },
      {
        "cnpj": "sample string 1",
        "mainSupplier": "sample string 2",
        "replicationIndicator": "sample string 3",
        "calculatesDiscountSuframaforPisCofins": "sample string 4",
        "ipiCollectionIndicator": "sample string 5",
        "mainControlIndicator": "sample string 6"
      }
    ],
    "divisions": [
      {
        "divisionNumber": 1,
        "standardPurchasePacking": 1.1,
        "seqBuyer": 2,
        "taxNumber": 3,
        "purposeFamily": "sample string 4",
        "formSupply": "sample string 5",
        "serviceFactor": 1,
        "profitMargin": 1.1,
        "replicationIndicator": "sample string 6",
        "seqCategory": 1
      },
      {
        "divisionNumber": 1,
        "standardPurchasePacking": 1.1,
        "seqBuyer": 2,
        "taxNumber": 3,
        "purposeFamily": "sample string 4",
        "formSupply": "sample string 5",
        "serviceFactor": 1,
        "profitMargin": 1.1,
        "replicationIndicator": "sample string 6",
        "seqCategory": 1
      }
    ]
  },
  "seqFamily": 1,
  "complement": "sample string 1",
  "reducedDescription": "sample string 2",
  "manufacturingProcessIndicator": "sample string 3",
  "genericDescription": "sample string 4",
  "anpCode": 1,
  "anpDescription": "sample string 5",
  "zeroBalancePriceIndicator": "sample string 6",
  "productControlTemperatureIndicator": "sample string 7",
  "replicationIndicator": "sample string 8",
  "issueTaxCodeInNFEIndicator": "sample string 9",
  "codes": [
    {
      "supplierCnpj": "sample string 1",
      "seqNetwork": 1,
      "codeType": "sample string 2",
      "packingQuantity": 1.1,
      "accessCode": "sample string 3",
      "usageForSaleIndicator": "sample string 4",
      "EANTaxableNFEIndicator": "sample string 5",
      "usageForNFEIndicator": "sample string 6"
    },
    {
      "supplierCnpj": "sample string 1",
      "seqNetwork": 1,
      "codeType": "sample string 2",
      "packingQuantity": 1.1,
      "accessCode": "sample string 3",
      "usageForSaleIndicator": "sample string 4",
      "EANTaxableNFEIndicator": "sample string 5",
      "usageForNFEIndicator": "sample string 6"
    }
  ],
  "images": [
    {
      "description": "sample string 1",
      "image": "sample string 2",
      "mainIndicator": "sample string 3",
      "pictureLayout": "sample string 4"
    },
    {
      "description": "sample string 1",
      "image": "sample string 2",
      "mainIndicator": "sample string 3",
      "pictureLayout": "sample string 4"
    }
  ]
}

application/x-www-form-urlencoded

Exemplo Exemplo (Sample):

Exemplo não disponível.

Informações para

...

Resposta (Response Information)

Descrição do

...

Recurso (Resource Description)

IHttpActionResult

Não há.

Formatos de

...

Resposta (Response Formats)

application/json, text/json, application/xml, text/xml

Exemplo (Sample):

Exemplo não disponível.