API de itens para parceiros do Marketplace

Quando você é parceiro do Marketplace, seus classificados ficam disponíveis no Facebook Marketplace em alguns países.

Para carregar, atualizar ou excluir seus produtos no Facebook Marketplace, você usará a interface GraphAPI.

HTTP

POST /v20.0/{product-catalog-id}/items_batch HTTP/1.1

Para saber como usar a Graph API, leia nosso guia Como usar a Graph API.

Se você postar nessa borda, será criado um Item de produto.

Parâmetros

ParâmetroDescrição

item_type

Definir como PRODUCT_ITEM

requests

O método e os campos para cada produto em uma série de produtos.

No parâmetro request, você vai definir o método e os dados do seu pedido.

CampoDescrição

method

A ação que você deseja realizar para um determinado produto. As opções são:
CREATE
UPDATE
DELETE

data

As informações sobre o produto que será criado, atualizado ou excluído.

Exemplo de parâmetro "request"

[
    {
        "method": "CREATE",
        "data": {
            "id": "UniqueProductID",
            "title": "Title",
            "description": "This is the description",
            "price": "100 USD",
            "image_link": "https:\/\/www.facebook.com",
            "brand": "Monster",
            "availability": "in stock",
            "condition": "new",
            "link": "https:\/\/www.facebook.com",
            "return_details": {"return_days": "30", "return_type": "SELLER_PAID_RETURN"},
            "partner_product_checkout_uri": "https:\/\/www.facebook.com",
            "partner_product_location": "San Fransisco, CA",
            "partner_product_expiration_time": "1923181264",
            "partner_delivery_method": ["shipping"],
            "partner_shipping_type": "fixed",
            "partner_shipping_cost": "14.95",
            "partner_shipping_speed": "3:5",
            "partner_attribute_data": {"color": "blue"},
            "partner_seller_id": "MySellerId1",
            "partner_item_country": "US"
        }
    },
    .... {next product}
]
   

Limite de volume da API

Para evitar a limitação, siga estas recomendações:

  • Não exceda 30 chamadas por minuto. Tudo que exceder será limitado.
  • Itens em lote em uma chamada à API, até 300.

Campos de itens do produto

ParâmetroTipoObrigatório/opcionalDescrição

id

String (limite máximo de caracteres: 100)

Obrigatório

Uma identificação de conteúdo única para o item. Use a SKU do item, se possível. Cada identificação de conteúdo deve aparecer somente uma vez no seu catálogo. Se houver várias instâncias do mesmo ID, ignoraremos todas elas.

Se os itens estiverem disponíveis em vários países, você deverá reutilizar o mesmo ID em todos os catálogos. Atualize o preço para a moeda do país (veja o campo de preço).

title

String (limite de caracteres: 200)

Obrigatório

O título do item de produto que aparece no classificado do Marketplace.

Este texto aparecerá no Marketplace. Não inclua tags HTML.

description

String (limite de caracteres: 9999)

Obrigatório

Descrição do produto. Embora o limite de caracteres desse campo seja 9.999, apenas os primeiros 256 caracteres serão mostrados no classificado no Facebook Marketplace.

Este texto aparecerá no Marketplace. Não inclua tags HTML.

Exemplo: Camiseta feminina azul royal confortável em algodão orgânico. Manga cavada e ajuste folgado. Perfeita para dias quentes de verão.

condition

Enum {new, refurbished, used, used_like_new, used_good, used_fair, cpo, open_box_new}

Obrigatório

A condição do item de produto.

partner_listing_type

Enum {fixed_price, auction, vehicle, rental, real_estate}

Opcional

Isso determina o tipo de classificado. Se não houver seleção, o padrão será "fixed_price".

Se definido como "auction", "vehicle", "rental" ou "real_estate", fornecerá a experiência do tipo de classificado do parceiro especificado para compradores no Marketplace.

partner_product_condition

Enum {acceptable, brand_new, certified_pre_owned, certified_refurbished, damaged, digital_good, excellent_refurbished, for_parts_or_not_working, good, good_refurbished, graded, like_new, new, new_other, new_other_see_details, new_with_box, new_with_defects, new_with_tags, open_box, others, pre_owned, remanufactured, retread, seller_refurbished, ungraded, used, very_good, very_good_refurbished, new_open_box, open_box_used, new_factory_sealed, unknown}

Opcional

Condições do produto. Campo opcional que será sobreposto ao campo de condição. Use se quiser mais especificidade para a condição do produto.

brand

String

Obrigatório

A marca do produto. Defina como "N/A" se não existir nenhuma marca.

price

String (limite de caracteres: 9999)

Obrigatório

O formato do preço deve conter um número, seguido por um espaço e por um código de moeda ISO 4217 de três letras. Exemplo: 10,99 EUR

Se o tipo de classificado for ‘auction’, este é o preço de lance do produto. O formato do preço deve conter um número, seguido por um espaço e por um código de moeda ISO 4217 de três letras.

availability

Enum {in stock, out of stock}

Obrigatório

Disponibilidade do item de produto.

link

String

Obrigatório

Link da web do URL móvel para a página de detalhes do produto.

partner_product_checkout_uri

String

Opcional

Link do URL de finalização da compra para o qual enviaríamos o usuário quando ele tocasse em Comprar no classificado.
Vamos adicionar click_id ao parâmetro. Se estiver ausente, o padrão será o URL do campo "link".

partner_product_html_desc_uri

String

Opcional

Link do URL para o site com a descrição completa do produto. Usado se a descrição do produto contiver mais do que pode caber no campo de texto "description". Como opção, o Marketplace fornecerá um link para a descrição completa.

image_link

String

Obrigatório

O URL da imagem principal do item. As imagens devem estar em formato JPEG ou PNG, além de ter pelo menos 500 x 500 pixels e até 8 MB. Veja as especificações de imagem do produto.

partner_seller_id

String (limite máximo de caracteres: 100)

Obrigatório

Identificador único do vendedor. Precisa corresponder a partner_seller_id nas informações do vendedor.

Exemplo: “partner_seller_id”: “great_seller_inc”

partner_item_country

Enum {AT, BE, BG, CY, CZ, DE, DK, EE, ES, FI, FR, GR, HR, HU, IE, IS, IT, LI, LT, LU, LV, MT, NL, NO, PL, PT, RO, SE, SI, SK}

Obrigatório

Este é o país em que o produto está disponível e, se aplicável, para o qual pode ser enviado. O país do catálogo precisa corresponder a partner_item_country.

Itens compatíveis com envios internacionais: é necessário criar um item no catálogo de cada país que oferece suporte para envio e em que o parceiro pretende distribuir.

fb_product_category

String

Opcional

Categoria de produto do Facebook para o item. A categoria de produto do Facebook mais específica possível desta lista: planilha (.csv) ou texto simples (.txt).

status

Enum {active, archived}

Opcional

O estado atual do produto.

sale_price

String

Opcional

O formato do preço deve conter um número, seguido por um espaço e por um código de moeda ISO 4217 de três letras. Exemplo: 10,99 EUR. Mesmo formato do campo de preço. Use em conjunto com o campo price para mostrar descontos.

sale_price_effective_date

String

Opcional

Data e hora de início e fim da promoção, separadas por uma barra. Escreva as datas de início e término como DD-MM-AAAA. Adicione um "T" após cada data e depois inclua a hora. Escreva a hora em um formato de 24 horas (0h00 a 23h59).

Exemplo: 2014-11-01T12:00-0300/2014-12-01T00:00-0300.

additional_image_link

String (limite de caracteres: 2000)

Opcional

URLs para até 20 imagens adicionais do seu item, separadas por vírgula (,), ponto e vírgula (;), espaço () ou barra vertical (|). Siga as mesmas especificações de imagem que image_link.

return_details

Objeto JSON que permite valor nulo (ou seja, mapa) { “return_days”: 30, “return_type”: enum }

enum: FINAL_SALE NO_RETURNS_WITH_EXCEPTION NO_RETURNS SELLER_PAID_RETURN BUYER_PAID_RETURN

Ou, se devoluções não estiverem disponíveis
“return_details”: null

Opcional

return_days indica o número de dias que o comprador tem para iniciar a devolução do produto.
return_days deve ser -1 para NO_RETURNS e FINAL_SALE

return_type indica o estilo de devolução aceito para o produto. As opções disponíveis incluem: FINAL_SALE, NO_RETURNS_WITH_EXCEPTION, NO_RETURNS, SELLER_PAID_RETURN, BUYER_PAID_RETURN

Se estiver vazio, os detalhes da devolução não serão mostrados.

partner_attribute_data

Objeto JSON que permite valor nulo { “color”: “blue” }

Chaves disponíveis: aspect_ratio, band_material, bike_type, brand, break_type, cable_length, capacity, case_size, certification, character, circulated_uncirculated, closure, color, compatible_bike_type, compatible_brand, compatible_model, compatible_operating_system, compatible_product, connectivity, credit_included, denomination, department, display_technology, dress_length, exterior_color, exterior_material, fabric_type, features, film_format, fit, focal_length, focus_type, form_factor, format, frame_color, game_name, game, gauge, golf_club_type, handedness, inseam, internet_connectivity, item_height, item_length, item_weight, item_width, items_included, main_stone, manufacturer_part_number, manufacturer, material, maximum_aperture, maximum_magnification, maximum_resolution, memory_cards_supported, metal_purity, metal, model, mount, mpn, network, number_of_items, occasion, outer_shell_material, package_quantity, part_type, pattern, performance_activity, platform, processor, publication_name, quantity, rack_type, rim_diameter, rim_width, ring_size, screen_size, section_width, series, set_includes, set, size_type, size, skirt_length, sleeve_length, sport_activity, sport, storage_capacity, style, type, unit_quantity, unit_type, upper_material, us_shoe_size, vintage, voltage, volume, waist_size, wheel_diameter, year

Opcional

Uma lista de valores-chave de atributos que serão exibidos na seção de detalhes do produto. Os valores são no formato de string.

Chaves aplicáveis a aluguéis/imóveis: property_type (required), sale_type, bed_bath, area_size, pet_friendly, ac_type, heating_type, laundry_type, parking_type, parkingSpace, furnishing_type, garden_type, tenure_type, listed_by, property_tax_and_condo_fee, construction_status, lease_duration, energy_rating_eu, co2_emission_rating

Chaves aplicáveis a veículos: vehicle_type, year, make, model, number_of_owners, trim, body_style, exterior_color, interior_color, transmission, fuel_type, mileage, money_still_owed, motorcycle_type, engine_size

partner_product_creation_time

Registro de data e hora UNIX em segundos UTC (número)

Opcional

Registro de data e hora UNIX de quando o produto foi criado ou atualizado.

Exemplo: “partner_product_creation_time”: 1713917255

partner_product_location

String

Opcional

Localização do item como string a ser exibida. Exemplo: "Paris, França". Pode ser específico ou amplo, não há restrições.

partner_product_expiration_time

Registro de data e hora UNIX em segundos UTC (número)

Opcional

Hora em que o classificado será removido do Marketplace. Deve ser uma hora no futuro.

partner_delivery_method

Matriz de enums de string {shipping, in_person}

Opcional

Mostra como o produto pode ser entregue a um comprador. Se um produto puder ser enviado e retirado pessoalmente, inclua as duas opções.
Exemplo: [“shipping”,”in_person”]

Padrão: [“shipping”]

partner_item_latitude

Flutuação

Opcional

Latitude do item. Necessário se o método de entrega incluir “in_person”.

partner_item_longitude

Flutuação

Opcional

Longitude do item. Necessário se o método de entrega incluir “in_person”.

partner_shipping_type

Enum {free, fixed, dynamic}

Opcional

Estratégia de preço de envio para o item. Se o envio for gratuito, use ‘free’. Se o envio tiver um preço fixo independentemente da localização, use ‘fixed’ e defina o custo em partner_shipping_cost. Se o preço de envio varia de acordo com a localização do comprador, escolhas de variantes etc., escolha ‘dynamic’. Se for dinâmico, não mostraremos o custo de envio, mas indicaremos que é possível ver o custo de envio durante a finalização da compra.

Padrão: "dynamic"

partner_shipping_cost

Flutuação

Opcional

Obrigatório se partner_shipping_type for ‘fixed’.
Exemplo: “14.95”

partner_shipping_speed

String
‘MIN_DELIVERY_SPEED_IN_DAYS:MAX_DELIVERY_SPEED_IN_DAYS’

Opcional

Quantidade mínima e máxima de dias úteis esperados para envio do item.
Exemplo: “3:5”

partner_auction_bid_close_time

Registro de data e hora UNIX em segundos UTC (número)

Opcional

Campo obrigatório se o partner_listing_type for 'auction'. É quando os lances para o produto são encerrados. Exemplo: “partner_auction_bid_close_time”: 1713917255

partner_auction_bid_count

Número

Opcional

Aplicável apenas se partner_listing_type for 'auction'. É o número atual de lances feitos no produto.

additional_fields

Objeto JSON que permite valor nulo

Forma livre (sem enumeração/chaves definidas)

{ “revised_title”: “Premium Blue T-Shirt” }

Opcional

Um campo JSON de forma livre para parceiros enviarem campos adicionais.

Verificar o status do carregamento

Depois que você enviar um pedido para criar, atualizar ou excluir, verá um nome de usuário. Você poderá verificar o resultado do envio com outro pedido.

O data -> status será definido como “finished” após a conclusão. Os erros e os avisos serão exibidos.

HTTP

GET /v20.0/{product-catalog-id}/check_batch_request_status?handle={your handle}

Exemplo de retorno

{
  "data": [
    {
      "handle": "Acy3FUJwzE10XnWrYr4ttrjOAfs-h6BUg-Wtg6sWGeV7qZZaErX15XPfqT_KWeyC6T4-nTbng9r1BJuScb6hgO1B",
      "status": "finished",
      "errors_total_count": 0,
      "errors": [
      ],
      "warnings": [
        {
          "line": 1,
          "id": "YourItemID",
          "message": "These attributes are invalid and need to be updated in the feed file: The product_tags information under  is invalid. Review for more details"
        }
      ],
      "ids_of_invalid_requests": [
      ]
    }
  ],
  "__www_request_id__": "Az3ghYsDh-101IH2t6DXKuP"
}
    

Para ver e gerenciar produtos

Para ver ou gerenciar produtos carregados no Gerenciador de Comércio. Quaisquer problemas com seus produtos aparecerão no Gerenciador de Comércio e poderão ser resolvidos na ferramenta.