Objetivo
A finalidade deste método é possibilitar o cadastro de uma família de produtos, incluindo dados de embalagens, associação a fornecedores, divisões de negócio e categorias.
Chamada
POST api/v3/products/familyInformações para Requisição (Request Information)
Parâmetros URI (URI Parameters)
Não há.
Parâmetros do Corpo (Body Parameters)
PostFamilyDTO
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| family | Descrição da Família | string | Obrigatório, Tamanho Máximo: 35 |
| weighable | Weighable indicator (Options: S – Yes / N – No) | string | Obrigatório, Tamanho Máximo: 1 |
| allowsDecimal | Indicator to allow decimal (Options: S – Yes / N – No) – (Default: N) | string | Tamanho Máximo: 1 |
| seqBrand | Brand code | integer | Não há. |
| containerIndicator | Indicator container (Options: S – Yes / N – No) – (Default: N) | string | Tamanho Máximo: 1 |
| allowsMultiplication | Indicator to allow multiplication (Options: S – Yes / N – No) – (Default: N | string | Tamanho Máximo: 1 |
| usesStockBatchIndicator | Indicator to require stock control (Options: S – Yes / N – No) | string | Tamanho Máximo: 1 |
| ipiAliquot | Aliquot of IPI – (Default: 0) | decimal number | Não há. |
| nfPisSituation | CST PIS Input | string | Tamanho Máximo: 2 |
| nfCofinsSituation | CST COFINS Input | string | Tamanho Máximo: 2 |
| nfPisLeaveSituation | CST PIS Output | string | Tamanho Máximo: 2 |
| nfCofinsLeaveSituation | CST COFINS Output | string | Tamanho Máximo: 2 |
| nbmshCode | NBM SH Code | string | Tamanho Máximo: 10 |
| cestCode | CEST Code | integer | Não há. |
| percentageImportTax | Importation Tax – Aliquote 2 – (Default: 0) | decimal number | Não há. |
| revenueIndicator | Revenue indicator (Options: S – Yes / N – No) – (Default: N) | string | Tamanho Máximo: 1 |
| similarIndicator | Similar indicator (Options: S – Yes / N – No) – (Default: N) | string | Tamanho Máximo: 1 |
| replicationIndicator | Replication indicator (Options: S – Yes / N – No) – (Default: S) | string | Tamanho Máximo: 1 |
| revenueType | Revenue type – (Default: 1) | integer | Não há. |
| taxationPisCofinsIndicator | Indicator for taxation of PIS and COFINS – (Default: I) | string | Tamanho Máximo: 1 |
| pisCofinsSimpleSituation | Situation PIS and COFINS simple (Options: S – Yes / N – No) – (Default: N) | string | Tamanho Máximo: 1 |
| packaging | Family packaging list | Collection | Obrigatório, PostFamilyPackingDTO |
| suppliers | Family suppliers list | Collection | Obrigatório, PostFamilySuppliersDTO |
| divisions | Family division list | Collection | Obrigatório, PostFamilyDivisionDTO |
PostFamilyPackingDTO
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| packingQuantity | Packing quantity – (Default: 1) | decimal number | Não há |
| packing | Packing – (Default: UN) | string | Tamanho Máximo: 2 |
| grossWeight | Gross weight – (Default: 0) | decimal number | Não há. |
| netWeight | Net weight – (Default: 0) | decimal number | Não há. |
| heigh | Heigh – (Default: 0) | decimal number | Não há. |
| width | Width – (Default: 0) | decimal number | Não há. |
| depth | Depth – (Default: 0) | decimal number | Não há. |
| status | Status (Options: A – Active / I – Inactive) – (Default: A) | string | Tamanho Máximo: 1 |
| packingUnitQuantity | Packing unit quantity – (Default: 1) | decimal number | Não há. |
| packingWeight | Packing weight (Options: S – Yes / N – No) – (Default: N) | string | Tamanho Máximo: 1 |
| replicationIndicator | Replication indicator (Options: S – Yes / N – No) – (Default: S) | string | Tamanho Máximo: 1 |
| liters | Liters – (Default: 0) | decimal number | Não há. |
| usesLabelProductBatch | Indicates if the packaging will be used in the issuing of labels of the production lots (OPTIONS: S – Yes / N – No) – (Default: N) Note: only when uses concept of issuing labels by multiple packaging | string | Tamanho Máximo: 1 |
| priceKindPacking | Package type price (N – Normal packing / P – Packing only for price) – (Default: N) | string | Tamanho Máximo: 1 |
| decimalPacking | Decimal packing (Options: S – Yes / N – No) – (Default: N) | string | Tamanho Máximo: 1 |
PostFamilySuppliersDTO
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| cnpj | CNPJ (Acceptable formats: 00.000.000/0001-00 or 00000000000000) | string | Obrigatório, Tamanho Máximo: 18 |
| mainSupplier | Main supplier (Options: S – Yes / N – No) – (Default: N) | string | Tamanho Máximo: 1 |
| replicationIndicator | Replication indicator (Options: S – Yes / N – No) – (Default: S) | string | Tamanho Máximo: 1 |
| calculatesDiscountSuframaforPisCofins | Calculates PIS and COFINS discount for SUFRAMA (Options: S – Yes / N – No) – (Default: S) | string | Tamanho Máximo: 1 |
| ipiCollectionIndicator | IPI collection indicator (Options: S – Yes / N – No) – (Default: N) | string | Tamanho Máximo: 1 |
| mainControlIndicator | Main control indicator (Options: S – Yes / N – No) – (Default: N) | string | Tamanho Máximo: 1 |
PostFamilyDivisionDTO
| Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
| divisionNumber | Division number | integer | Obrigatório |
| standardPurchasePacking | Standard purchase packing – (Default: 1) | decimal number | Não há. |
| seqBuyer | Buyer code | integer | Obrigatório |
| taxNumber | Tax number | integer | Obrigatório |
| purposeFamily | Purpose family (P – Raw Material, B – Toast, U – Material use consumption, A – Permanent assets, S – Services, G – Safe, F – Freight, D – Expenses, V – Exploitation, L – Worth or receipt, E – Packing, C – Product in process, Q – Finished product, T – Byproduct, I – Intermediary product, O – Other inputs, J – Related searches, N – Rest cred trib, M – Complement in advance, X – Guaranteed extended, Z – it’s gas, R – Merchandise for resale | string | Obrigatório Tamanho Máximo: 1 |
| formSupply | Form supply | string | Obrigatório Tamanho Máximo: 1 |
| serviceFactor | Service factor – (Default: 1) | integer | Não há. |
| profitMargin | Profit margin – (Default: 0) | decimal number | Não há. |
| replicationIndicator | Replication indicator (Options: S – Yes / N – No) – (Default: S) | string | Tamanho Máximo: 1 |
| seqCategory | Sequence of family category in division | integer | Não há. |
Formatos da Requisição (Request Formats)
application/json, text/json
Exemplo (Sample):
{
"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
}
]
}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
Não há.
Formatos de Resposta (Response Formats)
application/json, text/json, application/xml, text/xml
Exemplo (Sample):
Exemplo não disponível.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas