Cadastro de Produtos - POST

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 (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
dataFamily	Data 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 considered	PostFamilyDTO	Não há.
seqFamily	Family sequence Note: If this field is passed, the dataFamily field will be ignored	integer	Não há.
complement	Family description complement	string	Tamanho Máximo: 50
reducedDescription	Reduced description	string	Tamanho Máximo: 24
manufacturingProcessIndicator	Indicates 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)	string	Tamanho Máximo: 1
genericDescription	Generic description	string	Tamanho Máximo: 60
anpCode	ANP Code	integer	Não há.
anpDescription	Description of the product according to ANP	string	Tamanho Máximo: 95
zeroBalancePriceIndicator	Indicator to generate zero price for scales (S – Yes / N – No) – (Default: N)	string	Tamanho Máximo: 1
productControlTemperatureIndicator	Indicates whether the product controls the temperature (S – Yes / N – No) – (Default: N)	string	Tamanho Máximo: 1
replicationIndicator	Replicação indicator (S – Yes / N – No) – (Default: S)	string	Tamanho Máximo: 1
issueTaxCodeInNFEIndicator	Indicator for issuing fiscal product code in NFE (S – Yes / N – No) – (Default: N)	string	Tamanho Máximo: 1
codes	Access codes list	Collection of PostProductCodeDTO	Não há.
images	Images list	Collection of PostProductImageDTO	Não há.

PostProductCodeDTO

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
supplierCnpj	Supplier’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’	string	Tamanho Máximo: 18
seqNetwork	Network sequence Note: Must be informed when the codeTye field is ‘L’	integer	Não há.
codeType	Type of access code (A – AFV, C – Client, D – DUN, E – EAN/Barcode, F – Supplier, B – Internal, L – Customer network, I – Transition)	string	Obrigatório Tamanho Máximo: 1
packingQuantity	Packing quantity	decimal number	Não há.
accessCode	Access code	string	Obrigatório Tamanho Máximo: 60
usageForSaleIndicator	Usage for sale indicator – (Default: S)	string	Tamanho Máximo: 1
EANTaxableNFEIndicator	EAN taxable NFE indicator – (Default: N)	string	Tamanho Máximo: 1
usageForNFEIndicator	Usage FOR NFE Indicator – (Default: S)	string	Tamanho Máximo: 1

PostProductImageDTO

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
description	Description for the image	string	Obrigatório Tamanho Máximo: 40
image	Image in Base64. Valid Extensions: bmp, jpg, gif, png, tif, tiff	string	Obrigatório
mainIndicator	Main Image Indicator (Options: S – Yes / N – No) – (Default: S)	string	Tamanho Máximo: 1
pictureLayout	Image Layout (Options: F – Front, V – Verse, L – Side) – (Default: F)	string	Tamanho Máximo: 1

Formatos da Requisição (Request Formats)

application/json, text/json

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 (Sample):

Exemplo não disponível.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

IHttpActionResult