Domain Classes

Offer

XML format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<offer>
    <name>No Inferno É Sempre Assim e Outras Histórias Longe do Céu</name>
    <skuName>brochura|contos|Portuguȇs</skuName>
    <description>Um mendigo que espia, da vitrine de uma confeitaria, os deleites de uma mosca nos doces. O menino que se depara com uma nova existência a partir da morte da mãe.</description>
    <active>true</active>
    <price>80.99</price>
    <priceDiscount>75.99</priceDiscount>
    <quantity>80</quantity>
    <ean>9788562757273</ean>
    <urlImage>http://images.livrariasaraiva.com.br/imagemnet/imagem.aspx/imagem.aspx?pro_id=3534411</urlImage>
    <url>http://walmart.livrariasaraiva.com.br/parc/teste.htm?urlframe=%2fproduto%2f3534411%2fno-inferno-e-sempre-assim-e-outras-histrias-longe-do-cu&amp;PAC_ID=123634&amp;utm_source=walmart&amp;utm_medium=vitrine&amp;utm_campaign=WalmartMarketPlace</url>
    <sellerSKU>ABC3534411</sellerSKU>
    <sellerId>1</sellerId>
    <category>
        <name>Livros Didáticos</name>
        <active>true</active>
        <id_category>80</id_category>
        <parent>
            <name>Livros</name>
            <active>true</active>
            <id_category>79</id_category>
        </parent>
    </category>
    <brand>Dublinense</brand>
	<originCountry>BRA</originCountry>
    <images>
        <image name="lado a">
            <url>http://colocar_endereco.com/IMAGEM1_.jpg</url>
        </image>
        <image name="lado b">
            <url>http://colocar_endereco.com/IMAGEM2_.jpg</url>
        </image>
    </images>
    <height>15.00</height>
 	<width>10.00</width>
 	<length>11.00</length>
 	<weight>12.00</weight>
    <specifications>
        <specification name="author">
            <value>Langer, Daniela</value>
        </specification>
        <specification name="isbn">
            <value>9788562757273</value>
        </specification>
    </specifications>
</offer>

        

Json format

{
  "name" : "No Inferno É Sempre Assim e Outras Histórias Longe do Céu",
  "skuName" : "brochura|contos|Português",
  "description" : "Um mendigo que espia, da vitrine de uma confeitaria, os deleites de uma mosca nos doces. O menino que se depara com uma nova existência a partir da morte da mãe.",
  "active" : true,
  "price" : 80.99,
  "priceDiscount" : 75.99,
  "quantity" : 80,
  "ean" : "9788562757273",
  "urlImage" : "http://images.livrariasaraiva.com.br/imagemnet/imagem.aspx/imagem.aspx?pro_id=3534411",
  "url" : "http://walmart.livrariasaraiva.com.br/parc/teste.htm?urlframe=%2fproduto%2f3534411%2fno-inferno-e-sempre-assim-e-outras-histrias-longe-do-cu&PAC_ID=123634&utm_source=walmart&utm_medium=vitrine&utm_campaign=WalmartMarketPlace",
  "sellerId" : 1,
  "brand" : "Dublinense",
  "sellerSKU" : "ABC3534411",
  "category" : {
    "name" : "Livros Didáticos",
    "active" : true,
    "id_category" : 80,
    "parent" : {
      "name" : "Livros",
      "active" : true,
      "id_category" : 79,
      "parent" : null
    }
  },
  "height" : 15.00,
  "width" : 10.00,
  "length" : 11.00,
  "weight" : 12.00,
  "originCountry": "BRA",
  "images": [{
      "name": "lado a",
      "url": "http://colocar_endereco.com/IMAGEM1_.jpg"
    },{
      "name": "lado b",
      "url": "http://colocar_endereco.com/IMAGEM2_.jpg"
    }],
  "specifications" : [ {
    "name" : "author",
    "value" : "Langer, Daniela"
  }, {
    "name" : "isbn",
    "value" : "9788562757273"
  } ]
}
        			

Campo

Descrição

Tipo

Obrigatório

Tamanho

name Nome do produto da oferta String Sim 150
skuName Nome do sku da oferta (caso não tenha, será considerado o nome do produto da oferta) String Não 150
description Descrição da oferta (quanto mais detalhado, antes a ofertá será aprovada pela nossa equipe) String Sim 8000
active Flag para ativar/desativar a oferta Boolean Sim
price Preço da oferta ( Preço "De:") Numeric dot decimals Sim 19.2
priceDiscount Preço com desconto, preço de venda do produto (Preço “Por:”) Numeric dot decimals Sim 19.2
quantity Quantidade de produtos ofertados Numeric Sim 19
ean Número do EAN (código de barras contendo 13 dígitos utilizado em produtos no atacado e varejo mundialmente.) Numeric Não 14
urlImage URL da imagem padrão da oferta (tamanho do arquivo com no mínimo 16KB, a imagem no mínimo 240x240px). O tamanho ideal é 1000x1000px para permitir a visualização zoom. String Sim 1024
url URL do detalhe do produto do seller com informação da oferta String Não 1024
sellerId Identificação do seller Numeric Sim 19
height Altura do produto ofertado (cm) Numeric dot decimals Sim 19,2
weight Peso do produto ofertado (gramas) Numeric dot decimals Sim 19,2
length Comprimento do produto ofertado (cm) Numeric dot decimals Sim 19,2
width Largura do do produto ofertado (cm) Numeric dot decimals Sim 19,2
brand Marca da Oferta String Sim 255
sellerSKU Código do SKU da oferta no seller String Sim 50
category Árvore de categorias da oferta Category Sim
category:id Identificação da categoria do Walmart (uso específico do Walmart) Numeric Sim 19
category:name Nome da Categoria String Sim 2-400
category:active Flag com status da categoria Boolean Sim
category:id_category Identificação da categoria Numeric Não 19
category:parent Categoria relacionada categoria da oferta Category Não
category:sellerId Identificação do seller na categoria Numeric Sim 19
images Lista de imagens secundárias da oferta Image Não
images:name Nome da imagem String Sim 2-50
images:url URL da imagem padrão da oferta (tamanho do arquivo com no mínimo 16KB, a imagem no mínimo 240x240px). O tamanho ideal é 1000x1000px para permitir a visualização zoom. String Sim 1024
specifications Lista de Especificações quanto mais detalhadas as informações melhor. Caso as especificações do produto não sejam informadas, a oferta será rejeitada pela nossa equipe). Specification Sim
specifications:name Nome da especificação String Sim 50
specifications:value Atributos da especificação String Sim 5000
originCountry País de origem do Produto seguindo os padrões ISO 3166-1 alfa-3 (Ex: BRA) String Não 3

ListOffer

XML format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<collection>
    <offer>
	</offer>
	<offer>
	</offer>
</collection>
			        

Json format

{
  "offer": [{},{}]
}
			        

Order

Json format

{
  "marketplaceOrderId" : "MKT-1000121920192",
  "items" : [ {
    "id" : "ABC3534411",
    "quantity" : 1,
    "price" : 12.99,
    "commission" : 10,
    "freightCommission" : 2
  }, {
    "id" : "ABC3534412",
    "quantity" : 1,
    "price" : 16.99,
    "commission" : 10,
    "freightCommission" : 2
  } ],
  "clientProfileData" : {
    "email" : "basilio.jafet@palaciodoscedros.com.br",
    "firstName" : "Basílio Jafet Pereira",
    "lastName" : "Silva",
    "document" : "1234567890",
    "phone" : "1234567890",
    "corporateName" : "Nami Jafet e Irmãos",
    "tradeName" : "Nami Jafet e Irmãos",
    "corporateDocument" : "12345678901234567890",
    "stateInscription" : "20000516122345",
    "corporatePhone" : "1257890",
    "isCorporate" : true
  },
  "shippingData" : {
    "address" : {
      "addressId" : "Minha Casa",
      "addressType" : "residential",
      "receiverName" : "Adma Jafet",
      "postalCode" : "03424-101",
      "city" : "São Paulo",
      "state" : "SP",
      "country" : "BRA",
      "street" : "Rua Bom Pastor",
      "number" : "800",
      "neighborhood" : "Ipiranga",
      "complement" : "complement:69",
      "reference" : "Próximo ao Museu do Ipiranga"
    },
    "logisticsInfo" : [ {
      "item" : 0,
      "shippingType" : "Agendada",
      "shippingLockTTL" : "3d",
      "shippingEstimate" : "6bd",
      "deliveryWindow" : {
        "startDate" : "2000-05-16T12:23:45",
        "endDate" : "2000-05-16T12:23:45",
        "price" : 12.50
      }
    }, {
      "item" : 1,
      "shippingType" : "Normal",
      "shippingLockTTL" : "2d",
      "shippingEstimate" : "5d",
      "price" : 10.99,
      "deliveryWindow" : null
    } ]
  }
}

Campo

Descrição

Tipo

Obrigatório

Tamanho

marketplaceOrderId Identificação da ordem de compra do marketplace String Sim 255
items Lista de itens da compra Item Sim
items:id Identificação do item do seller (número do sku da oferta) String Sim 50
items:quantity Quatidade de itens Numeric Sim 19
items:price Preço do item Numeric dot decimals Sim 19,2
items:freightCommission Comissão do frete do item (valor em percentual multicado por 100) Numeric dot decimals Não 19,2
items:commission Comissão do preço do item (valor em percentual multiplicado por 100) Numeric dot decimals Não 19,2
clientProfileData Informações do cliente String Sim
clientProfileData:email E-mail do cliente String Não 255
clientProfileData:firstName Nome do cliente String Não 255
clientProfileData:lastName Sobrenome do cliente (pode está vazio e não obrigatório, nesse casso o primeiro nome será utilizado caso seja necessário) String Não 255
clientProfileData:document CPF do cliente String Não 255
clientProfileData:phone Telefone do cliente String Não 255
clientProfileData:corporateName Nome da empresa do cliente String Não 255
clientProfileData:tradeName Nome comercial da empresa do cliente (nome fantasia) String Não 255
clientProfileData:corporateDocument CNPJ da empresa do cliente String Não 255
clientProfileData:stateInscription Inscrição estadual da empresa do cliente String Não 255
clientProfileData:corporatePhone Telefone da empresa do cliente String Não 255
clientProfileData:isCorporate Flag que indica se o cliente é um empresa (Pessoa Jurídica) Boolean Não
shippingData Informação da entrega ShippingData Sim
shippingData:address Informação sobre o endereço de entrega Address Sim
shippingData:address:addressId Identificação do endereço de entrega String Não 255
shippingData:address:addressType Tipo do endereço (Residencial ou Comercial) String Não 255
shippingData:address:receiverName Nome da pessoa que irá receber o pedido String Não 255
shippingData:address:postalCode CEP do endereço String Não 255
shippingData:address:city Cidade String Não 255
shippingData:address:state Estado String Não 255
shippingData:address:country País String Não 255
shippingData:address:street Rua String Não 255
shippingData:address:number Número("S/N" quando não houver) String Não 255
shippingData:address:neighborhood Bairro String Não 255
shippingData:address:complement Complemento String Não 255
shippingData:address:reference Ponto de referência String Não 255
shippingData:logisticsInfo Informação sobre a lojística da entrega logisticsInfo Sim
shippingData:logisticsInfo:itemIndex Índice do item dentro da lista de item Numeric Sim 19
shippingData:logisticsInfo:shippingType Tipo de entrega (valor retornado em FulfillmentPreviewResponse:shipmentInfos.categories:category:id). Ex: Agendada/Normal, X, Y String Sim 255
shippingData:logisticsInfo:shippingLockTTL Máximo de tempo que o vendedor deve deixar o estoque reservado até que tenha a confirmação do pagamento. (Exemplo: 5d = 5 dias) String Sim 255
shippingData:logisticsInfo:shippingEstimate Estimativa de entrega. Ex: 5d = 5 dias, 5bd = 5 dias úteis String Sim 255
shippingData:logisticsInfo:price Valor do frete por item (somente para entrega não agendada) Numeric dot decimals Sim 19,2
shippingData:logisticsInfo:deliveryWindow Informações sobre a entrega (somente para os itens de entrega agendadas) DeliveryWindow Não
shippingData:logisticsInfo:deliveryWindow:startDate Data de início da janela de entrega Date Sim
shippingData:logisticsInfo:deliveryWindow:endDate Data final da janela de entrega Date Sim
shippingData:logisticsInfo:deliveryWindow:price Valor do frete por item Numeric dot decimals Sim 19,2

OrderResponse

Json format

{
  "orderId" : "1287127"
}
				

Campo

Descrição

Tipo

Obrigatório

Tamanho

orderId Número do pedido do Seller String Sim 255

ConfirmFulfillmentOrder

Json format

{
  "orderId" : "1287127"
}
			      

Campo

Descrição

Tipo

Obrigatório

Tamanho

orderId Número do pedido do Seller String Sim 255

ConfirmFulfillmentOrderResponse

Json format

{
  "orderId" : "1287127"
}
			        

Campo

Descrição

Tipo

Obrigatório

Tamanho

orderId Número do pedido do Seller String Sim 255

CancelFulfillmentOrder

Json format

{
  "orderId" : "1287127"
}
			        

Campo

Descrição

Tipo

Obrigatório

Tamanho

orderId Número do pedido do Seller String Sim 256

CancelFulfillmentOrderResponse

Json format

{
  "orderId" : "1287127"
}
			        

Campo

Descrição

Tipo

Tamanho

orderId Número do pedido do Seller String Sim 255

FulfillmentPreview

Json format

{
  "postalCode" : "04145010",
  "country" : "BRA",
  "items" : [ {
    "id" : "ABC3534411",
    "quantity" : 80
  }, {
    "id" : "ABC3534412",
    "quantity" : 101
  } ]
}
			        

Campo

Descrição

Tipo

Obrigatório

Tamanho

postalCode CEP da entrega String Sim 255
country País da entrega String Sim 3
items Lista de itens Item Sim
items: id Identificação do Item do seller (número do SKU) String Sim 50
items: quantity Quantidade de itens para o seller Numeric Sim 19

FulfillmentPreviewResponse

Json format

{
  "items" : [ {
    "id" : "ABC3534411",
    "quantity" : 80,
    "price" : 12.23,
    "listPrice" : 12.99
  }, {
    "id" : "ABC3534412",
    "quantity" : 101,
    "price" : 12.23,
    "listPrice" : 12.99
  } ],
  "country" : "BRA",
  "postalCode" : "04145010",
  "shipmentInfos" : [ {
    "itemId" : "ABC3534411",
    "inventoryAvailable" : 101,
    "quantity" : 80,
    "categories" : [ {
      "id" : "Forma de Entrega X",
      "name" : "Entrega Normal",
      "shippingEstimate" : "2bd",
      "price" : 3.90,
      "scheduledDeliveries" : []
    },{
      "id" : "Agendada",
      "name" : "Entrega Agendada",
      "shippingEstimate" : "2bd",
      "scheduledDeliveries" : [ {
        "startDate" : "2000-05-16T12:23:45",
        "endDate" : "2000-05-16T12:23:45",
        "price" : 4.63
      } ]
    }]
  }, {
    "itemId" : "ABC35344112",
    "inventoryAvailable" : 102,
    "quantity" : 101,
    "categories" : [ {
      "id" : "Normal",
      "name" : "Entrega Normal",
      "shippingEstimate" : "2bd",
      "price" : 5.99,
      "scheduledDeliveries" : []
    },
    {
      "id" : "Agendada",
      "name" : "Entrega Agendada",
      "shippingEstimate" : "2bd",
      "scheduledDeliveries" : [ {
        "startDate" : "2000-05-16T12:23:45",
        "endDate" : "2000-05-16T12:23:45",
        "price" : 5.99
      } ]
    }]
  } ]
}
        

Campo

Descrição

Tipo

Obrigatório

Tamanho

items Lista de itens Array Sim
items:id Identificação do item do seller (número do SKU) String Sim 50
items:quantity Quantidade de itens Numeric Sim 19
items:price Preço "Por" Numeric dot Decimals Sim 19,2
items:listPrice Preço "De" Numeric dot Decimals Sim 19,2
items:priceValidUntil Validade do preço Date Não
country País para entrega String Sim 3
postalCode CEP para entrega String Sim 255
shipmentInfo Informações logísticas dos itens ShipmentInfo Sim
shipmentInfo:itemId Identificação do item do seller (número do SKU da oferta) String Sim 50
shipmentInfo:inventoryAvailable Quantidade de itens disponíveis em estoque Numeric Sim 19
shipmentInfo:quantity Quantidade de itens solicitados Numeric Sim 19
shipmentInfo:categories Informações de entrega Array Não
shipmentInfo:categories:id Identificação do tipo de entrega String Sim 50
shipmentInfo:categories:name Nome do tipo de entrega String Sim 255
shipmentInfo:categories:shippingEstimate Estimativa de entrega String Sim 255
shipmentInfo:categories:price Valor do frete por item (somente para entrega não agendada) Numeric dot decimals Sim 19,2
shipmentInfo:categories:scheduledDeliveries Intervalo para entrega agendada Array Não
shipmentInfo:categories:scheduledDeliveries:startDate Data de início da entrega agendada Date Sim
shipmentInfo:categories:scheduledDeliveries:endDate Data final da entrega agendada Date Sim
shipmentInfo:categories:scheduledDeliveries:price Valor do frete por item Numeric dot decimals Sim 19,2

ShipmentNotification

XML format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipmentNotification>
 <items>
        <item>
            <id>ABC3534411</id>
            <quantity>80</quantity>
        </item>
        <item>
            <id>ABC3534412</id>
            <quantity>101</quantity>
        </item>
    </items>
    <trackingNumber>SS987654321BR</trackingNumber>
    <courier>Correios - SEDEX</courier>
    <invoiceNumber>IV65243643</invoiceNumber>
    <invoiceValue>140099</invoiceValue>
    <invoiceUrl>https://nfe.prefeitura.sp.gov.br/nfe.aspx?ccm=12345678&nf=12345678&cod=1232SRV1E</invoiceUrl>
    <embeddedInvoice>51080701212344000127550010000000981364112281</embeddedInvoice>
    <issuanceDate>2000-05-16T12:23:45</issuanceDate>
</shipmentNotification>

        

Json format

{
  "items" : [ {
    "id" : "ABC3534411",
    "quantity" : 80
  }, {
    "id" : "ABC3534412",
    "quantity" : 101
  } ],
  "trackingNumber" : "SS987654321BR",
  "courier" : "Correios - SEDE",
  "invoiceNumber" : "IV65243643",
  "invoiceValue" : 140099,
  "invoiceUrl" : "https://nfe.prefeitura.sp.gov.br/nfe.aspx?ccm=12345678&nf=12345678&cod=1232SRV1E",
  "embeddedInvoice" : "51080701212344000127550010000000981364112281",
  "issuanceDate": "2000-05-16T12:23:45"
  
}
        

Campo

Descrição

Tipo

Obrigatório

Tamanho

items Lista de itens Item Sim
items: id Identificação do Item para o seller (número do SKU) String Sim 50
items: quantity Quantidade de itens para o seller Numeric Sim 19
trackingNumber Número de referencia do pedido na transportadora String Sim 255
courier Type do correio, e.g.: Correios - SEDEX, Correios - PAC String Sim 255
invoiceNumber Número da fatura String Não 255
invoiceValue Valor da fatura Long Não 19
invoiceUrl Url da fatura String Não 1024
embeddedInvoice Fatura embutida (Use o format da Nota Fiscal Eletrônica (http://www.nfe.fazenda.gov.br) String Não 255
issuanceDate Data de emissão da fatura Date Não

ShipmentNotificationResponse

XML format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipmentNotificationResponse>
    <receipt>receipt:100</receipt>
</shipmentNotificationResponse>

        

Json format

{
  "receipt" : "receipt:100"
}
        

Campo

Descrição

Tipo

Obrigatório

Tamanho

receipt Número do recibo, indica que o pedido foi recebido String Sim 255

CancelShipmentNotification

XML format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipmentNotification>
	<items>
        <item>
            <id>ABC3534411</id>
            <quantity>80</quantity>
        </item>
        <item>
            <id>ABC3534412</id>
            <quantity>101</quantity>
        </item>
    </items>
</shipmentNotification>

        

Json format

{
  "items" : [ {
    "id" : "ABC3534411",
    "quantity" : 80
  }, {
    "id" : "ABC3534412",
    "quantity" : 101
  } ]
}
        

Campo

Descrição

Tipo

Obrigatório

Tamanho

items List of items Item Sim
items:id Identificação do item para o seller String Sim 50
items:quantity Quantidade de itens para o seller Numeric Sim 19

CancelShipmentNotificationResponse

XML format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shipmentNotificationResponse>
    <receipt>receipt:100</receipt>
</shipmentNotificationResponse>

        

Json format

{
  "receipt" : "receipt:100"
}
        

Campo

Descrição

Tipo

Obrigatório

Tamanho

receipt Número do recibo, indica que o pedido foi cancelado. String Sim 255

OrderStatusResponse

XML format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<orderStatusResponse>
    <orderStatus>pending</orderStatus>
</orderStatusResponse>

        

Json format

{
  "orderStatus" : "PENDING"
}
        

Campo

Descrição

Tipo

Tamanho

orderStatus Status do pedido:
PENDING: Quando o pedido está pendente de confirmação de pagamento.
CONFIRMED: Quando o pedido teve a confirmação de pagamento.
CANCELED: Quando o pedido foi cancelado pelo Walmart.
SHIPPED: Quando o pedido foi entregue ao cliente pelo Seller.
SHIPPING_CANCELED: Quando o seller cancelou o pedido.
ERROR_CONFIRM: Quando ocorreu algum erro ao tentar sinalizar o Seller que o pedido teve a confirmação de pagamento. (Erro do lado do Walmart ou do Seller).
ERROR_CANCEL: Quando ocorreu algum erro ao tentar sinalizar o Seller que o pedido foi cancelado. (Erro do lado do Walmart ou do Seller).
ERROR_SHIPPING: Quando ocorreu algum erro ao tentar sinalizar o Walmart que o pedido foi entregue. (Erro do lado do Walmart ou do Seller).
ERROR_CANCEL_SHIPPING: Quando ocorreu algum erro ao tentar sinalizar o Walmart que o pedido foi cancelado. (Erro do lado do Walmart ou do Seller).
String