Step-by-Step Guide on How to Develop Salesforce B2C Commerce API (SCAPI) Integration via API2Cart
Request a free trial
Start your free 14-day trial and register your API2Cart account.
Add SCAPI store
Add your clients' store to your Salesforce B2C Commerce API (SCAPI) account or test which data you can work with using our demo stores.
Integrate your software with API2Cart
Develop an integration between your software or app and API2Cart.
Lista de métodos para SCAPI Integration
-
account.failed_webhooks
Se o retorno de chamada do seu serviço, por algum motivo, não puder aceitar webhooks de API2Cart, então, com a ajuda deste método, você poderá obter uma lista de webhooks perdidos para realizar a sincronização novamente usando entity_id. Observe que mantemos esses registros por 24 horas. -
account.supported_platforms
Use este método para recuperar uma lista de plataformas suportadas e os conjuntos de parâmetros necessários para conectar-se a cada uma delas. Nota: algumas plataformas podem ter vários métodos de conexão para que a resposta contenha vários conjuntos de parâmetros. -
account.cart.list
Este método permite obter uma lista de lojas online conectadas à sua conta API2Cart. -
account.cart.add
Use este método para automatizar o processo de conexão de lojas a API2Cart. -
account.config.update
Use este método para automatizar a alteração de credenciais usadas para conectar lojas online.
-
analytics.report
Obtenha um relatório analítico com totais e detalhamento opcional por intervalos para uma loja em um determinado período. -
analytics.product_report
Obtenha análises ao nível do produto para uma loja em um determinado período. -
analytics.customer_report
Obtenha análises ao nível do cliente para uma loja em um determinado período.
-
attribute.info
Obtenha informações sobre um atributo global específico por seu ID. -
attribute.count
Obtenha contagem de atributos. -
attribute.list
Obtenha uma lista de atributos globais. -
attribute.add
Adicione novo atributo. -
attribute.update
Atualizar dados de atributos. -
attribute.delete
Exclua o atributo da loja. -
attribute.assign.group
Atribuir atributo ao grupo -
attribute.assign.set
Atribuir atributo ao conjunto de atributos -
attribute.attributeset.list
Obtenha a lista attribute_set -
attribute.group.list
Obter lista de grupos de atributos -
attribute.type.list
Obtenha uma lista de tipos de atributos suportados. -
attribute.unassign.group
Cancelar atribuição de atributo do grupo -
attribute.unassign.set
Cancelar atribuição de atributo do conjunto de atributos -
attribute.value.add
Adicione novo valor ao atributo. -
attribute.value.update
Atualize o valor do atributo. -
attribute.value.delete
Exclua o valor do atributo.
-
basket.info
Recuperar informações da cesta. -
basket.item.add
Adicione item ao carrinho. -
basket.live_shipping_service.list
Recupere uma lista de serviços de taxas de envio em tempo real. -
basket.live_shipping_service.create
Crie um serviço de taxa de envio ao vivo. -
basket.live_shipping_service.delete
Exclua o serviço de taxa de envio em tempo real.
-
batch.job.list
Obtenha uma lista de empregos recentes -
batch.job.result
Obtenha dados de resultados de trabalhos
-
bridge.download
Baixe a ponte para a loja.Observe que o método não funcionaria se você o chamasse de Swagger UI. -
bridge.update
Atualize a ponte na loja. -
bridge.delete
Exclua a ponte da loja.
-
cart.info
Este método permite obter várias informações sobre a loja, incluindo uma lista de lojas (no caso de uma configuração multiloja), uma lista de idiomas suportados, moedas, transportadoras, armazéns e muitas outras informações. Esses dados são relativamente estáveis e mudam raramente, portanto a API2Cart pode armazenar certos dados em cache para reduzir a carga na loja e acelerar a execução da solicitação. Também recomendamos armazenar em cache a resposta deste método do seu lado para economizar requisições. Se precisar limpar o cache de uma loja específica, use o método cart.validate. -
cart.validate
Este método limpa o cache em API2Cart para um determinado armazenamento e verifica se a conexão com o armazenamento está disponível. Use este método se houver alguma alteração nas configurações da loja, por exemplo, se um novo plugin tiver sido instalado ou removido. -
cart.list
Obtenha a lista de carrinhos suportados. -
cart.bridge
Obtenha a chave bridge e a chave da loja. -
cart.disconnect
Desconecte-se do armazenamento e limpe os dados da sessão do armazenamento. -
cart.methods
Retorna uma lista de métodos de API suportados. -
cart.config
Obtenha a lista de configurações do carrinho. -
cart.clear_cache
Limpar cache na loja. -
cart.create
Adicionar estabelecimento à conta. -
cart.delete
Remover loja de API2Cart. -
cart.catalog_price_rules.count
Obtenha a contagem de descontos nas regras de preço do catálogo de carrinhos. -
cart.catalog_price_rules.list
Obtenha descontos nas regras de preço do catálogo de carrinhos. -
cart.config.update
Use este método de API para atualizar dados personalizados no banco de dados do cliente. -
cart.coupon.count
Este método permite-lhe obter o número de cupões. Em algumas plataformas, pode filtrar os cupões pela data em que estiveram ativos. -
cart.coupon.list
Obtenha descontos em cupões de carrinho. -
cart.coupon.add
Use este método para criar um cupão com as condições especificadas. -
cart.coupon.delete
Eliminar cupão -
cart.coupon.condition.add
Utilize este método para adicionar condições adicionais para a aplicação do cupão. -
cart.giftcard.count
Obtenha a contagem de cartões de oferta. -
cart.giftcard.list
Obtenha a lista de cartões de oferta. -
cart.giftcard.add
Use este método para criar um cartão de presente para um valor especificado. -
cart.giftcard.delete
Eliminar cartão de oferta. -
cart.meta_data.list
Usando este método, você pode obter uma lista de metadados para várias entidades. As entidades suportadas podem variar entre plataformas. Para obter a lista de entidades suportadas, passe um valor inválido no parâmetroentity. A resposta conterá a lista de entidades suportadas pela plataforma específica. Normalmente, são dados criados por plugins de terceiros. -
cart.meta_data.set
Defina metadados para uma entidade específica usando este método. As entidades suportadas podem variar entre plataformas. Para obter a lista de entidades suportadas, passe um valor inválido no parâmetroentity. A resposta conterá a lista de entidades suportadas pela plataforma específica. Normalmente, são dados criados por plugins de terceiros. -
cart.meta_data.unset
Desconfigurar metadados para uma entidade específica. -
cart.plugin.list
Obtenha uma lista de plugins de terceiros instalados na loja. -
cart.script.list
Obtenha scripts instalados na vitrine. -
cart.script.add
Adicionar novo script à vitrine. -
cart.script.delete
Remova o script da vitrine. -
cart.shipping_zones.list
Obtenha uma lista de zonas de envio.
-
category.info
Obtenha informações da categoria sobre o ID da categoria*** ou especifique outro ID da categoria. -
category.count
Conte categorias na loja. -
category.list
Obtenha uma lista de categorias da loja. -
category.find
Categoria de pesquisa na loja. 'Laptop' é especificado aqui por padrão. -
category.assign
Atribuir categoria ao produto -
category.unassign
Cancelar atribuição de categoria ao produto -
category.add
Adicionar nova categoria na loja -
category.add.batch
Adicione novas categorias à loja. -
category.update
Atualizar categoria na loja -
category.delete
Excluir categoria na loja -
category.delete.batch
Exclua categorias da loja. -
category.image.add
Adicionar imagem à categoria -
category.image.delete
Excluir imagem
-
customer.info
Obtenha detalhes dos clientes na loja. -
customer.count
Obtenha o número de clientes da loja. -
customer.list
Obtenha a lista de clientes da loja. -
customer.find
Encontre clientes na loja. -
customer.add
Adicione o cliente à loja. -
customer.update
Atualizar informações do cliente na loja. -
customer.delete
Excluir cliente da loja. -
customer.address.add
Adicione o endereço do cliente. -
customer.attribute.list
Obtenha atributos para um cliente específico. -
customer.group.list
Obtenha uma lista de grupos de clientes. -
customer.group.add
Crie um grupo de clientes. -
customer.wishlist.list
Obtenha uma lista de desejos do cliente da loja.
-
marketplace.product.find
Pesquise produtos no catálogo global.
-
order.info
Informações sobre um pedido específico por ID -
order.count
Contar pedidos na loja -
order.list
Obtenha a lista de pedidos da loja. -
order.find
Este método está obsoleto e não terá suporte no futuro. Use 'order.list' em vez disso. -
order.calculate
Calcula o custo total de um pedido para um determinado cliente e um conjunto de produtos, bem como os métodos de envio disponíveis com base no endereço especificado. O cálculo leva em consideração os preços dos produtos na loja, descontos, impostos, custos de envio e outras configurações da loja. O resultado inclui uma análise detalhada do custo final do pedido por seus componentes.
Observe que os totais finais, impostos e outros valores devem incluir os valores correspondentes ao método de envio selecionado.
O resultado deste método pode ser utilizado ao criar um pedido usando o método order.add.
-
order.add
Adicione um novo pedido ao carrinho. -
order.update
Atualize o pedido existente. -
order.abandoned.list
Obtenha uma lista de pedidos deixados pelos clientes antes de concluí-los. -
order.financial_status.list
Recuperar lista de status financeiros -
order.fulfillment_status.list
Recuperar lista de status de cumprimento -
order.preestimate_shipping.list
Recuperar lista de métodos de envio pré-estimados do pedido. -
order.refund.add
Adicione um reembolso ao pedido. -
order.return.add
Crie uma nova solicitação de devolução. -
order.return.update
Atualize as informações de envio do pedido. -
order.return.delete
Excluir retorno. -
order.shipment.info
Obtenha informações de envio. -
order.shipment.list
Obtenha lista de remessas por pedido. -
order.shipment.add
Adicione uma remessa ao pedido. -
order.shipment.add.batch
Adicione uma remessa aos pedidos. -
order.shipment.update
Atualize as informações de envio do pedido. -
order.shipment.delete
Excluir envio do pedido. -
order.shipment.event.list
Obtenha lista de eventos de rastreamento de remessa. -
order.shipment.event.add
Adicione um evento de rastreamento à remessa. -
order.shipment.tracking.add
Adicione informações de rastreamento da remessa do pedido. -
order.status.list
Recuperar lista de status -
order.transaction.list
Recuperar lista de transações de pedidos.
-
product.info
Obtenha informações sobre um produto específico por seu ID. No caso de uma configuração multistore, utilize o filtro store_id para obter uma resposta no contexto de uma loja específica. -
product.count
Conte os produtos na loja. -
product.list
Obtenha uma lista de produtos da sua loja. Retorna 10 produtos por padrão. -
product.find
Pesquise produtos no catálogo da loja. 'Apple' é especificado aqui por padrão. -
product.fields
Recuperar todos os campos disponíveis para item de produto na loja. -
product.add
Adicione novo produto à loja. -
product.add.batch
Adicione novos produtos à loja. -
product.update
Este método pode ser usado para atualizar determinados dados do produto. A lista de parâmetros suportados depende da plataforma específica. Transmita apenas os parâmetros suportados pela plataforma específica. Observe que para atualizar a quantidade do produto, é recomendado usar parâmetros relativos (increase_quantity ou reduce_quantity) para evitar substituições inesperadas em lojas muito carregadas. -
product.update.batch
Atualizar produtos na loja. -
product.delete
Exclusão de produto -
product.delete.batch
Retire o produto da loja. -
product.attribute.list
Obtenha uma lista de atributos e valores. -
product.attribute.value.set
Defina o valor do atributo para o produto. -
product.attribute.value.unset
Remove o valor do atributo de um produto. -
product.brand.list
Obtenha uma lista de marcas da sua loja. -
product.child_item.info
Obtenha filho para um produto específico. -
product.child_item.list
Obtenha uma lista dos itens secundários de um produto, como variantes ou componentes de pacote. O campo total_count na resposta indica o número total de itens no contexto do filtro atual. -
product.child_item.find
Pesquise o item filho do produto (item em pacote ou variante de produto configurável) no catálogo da loja. -
product.currency.list
Obtenha uma lista de moedas. -
product.currency.add
Adicione moeda e/ou defina o padrão na loja. -
product.image.add
Adicionar imagem ao produto -
product.image.update
Atualizar detalhes da imagem -
product.image.delete
Excluir imagem -
product.manufacturer.add
Adicione o fabricante para armazenar e atribuir ao produto. -
product.option.list
Obtenha uma lista de opções. -
product.option.assign
Atribuir opção do produto. -
product.option.add
Adicionar opção de produto da loja. -
product.option.delete
Opção de produto excluída. -
product.option.value.assign
Atribuir item de opção de produto do produto. -
product.option.value.add
Adicione o item de opção de produto da opção. -
product.option.value.update
Atualize o item de opção do produto da opção. -
product.option.value.delete
Exclusão do valor da opção do produto. -
product.price.add
Adicione alguns preços ao produto. -
product.price.update
Atualize alguns preços do produto. -
product.price.delete
Excluir alguns preços do produto -
product.review.list
Obtenha avaliações de um produto específico. -
product.store.assign
Atribuir produto à loja. -
product.tax.add
Adicione classe de imposto e taxa de imposto para armazenar e atribuir ao produto. -
product.variant.info
Obtenha informações sobre variantes. Este método está obsoleto e seu desenvolvimento foi interrompido. Use 'product.child_item.info' em vez disso. -
product.variant.count
Obtenha variantes de contagem. -
product.variant.list
Obtenha uma lista de variantes. Este método está obsoleto e seu desenvolvimento foi interrompido. Use 'product.child_item.list' em vez disso. -
product.variant.add
Adicione variante ao produto. -
product.variant.add.batch
Adicione novas variantes de produtos à loja. -
product.variant.update
Variante de atualização. -
product.variant.update.batch
Atualize as variantes dos produtos na loja. -
product.variant.delete
Excluir variante. -
product.variant.delete.batch
Remova variantes de produtos da loja. -
product.variant.image.add
Adicionar imagem ao produto -
product.variant.image.delete
Excluir imagem do produto -
product.variant.price.add
Adicione alguns preços à variante do produto. -
product.variant.price.update
Atualize alguns preços da variante do produto. -
product.variant.price.delete
Exclua alguns preços da variante do produto.
-
return.info
Recuperar informações de retorno. -
return.count
Contar devoluções na loja -
return.list
Obtenha uma lista de solicitações de devolução da loja. -
return.action.list
Recuperar lista de ações de retorno -
return.reason.list
Recuperar lista de motivos de devolução -
return.status.list
Recuperar lista de status
-
subscriber.list
Obtenha lista de assinantes.
-
tax.class.info
Use este método para obter informações sobre uma classe de imposto e suas alíquotas. Ele permite calcular a porcentagem de imposto para o endereço de um cliente específico. Essas informações contêm dados relativamente estáticos que raramente mudam, portanto, API2Cart pode armazenar determinados dados em cache para reduzir a carga no armazenamento e acelerar a execução da solicitação. Também recomendamos que você armazene em cache a resposta desse método para salvar solicitações. Se você precisar limpar o cache de um armazenamento específico, use o método cart.validate. -
tax.class.list
Obtenha uma lista de classes fiscais de sua loja.
-
webhook.count
Contagem de webhooks cadastrados na loja. -
webhook.list
Listar webhook cadastrado na loja. -
webhook.events
Liste todos os Webhooks disponíveis nesta loja. -
webhook.create
Crie um webhook na loja e assine-o. -
webhook.update
Atualize os parâmetros dos Webhooks. -
webhook.delete
Eliminar webhook registado na loja.
Download Your Salesforce B2C Commerce API (SCAPI) Integration Guide
Learn how to integrate with Salesforce B2C Commerce API (SCAPI) in an easy and unified way.
Inside you'll discover:
- Integration Challenges: What SaaS providers usually face when connecting with Salesforce B2C Commerce API (SCAPI).
- Unified API Solution: How one unified eCommerce API makes it easy to integrate with Salesforce B2C Commerce API (SCAPI) and 80+ other platforms.
- Use Cases: Industries that rely on successful integration development.
- Success Stories: How SaaS vendors simplified eCommerce integration development.
Develop Integrations Faster and Save Up to 9x on Costs
Trusted by
Ready to simplify eCommerce integration development?
Connect your SaaS to Salesforce B2C Commerce API (SCAPI) and multiple other eCommerce platforms faster and easier.
FAQs
What is SCAPI integration?
SCAPI integration is the process of connecting eCommerce SaaS or apps with SCAPI stores. Through this connection, they can get, add, update and sync various store data like orders, products, categories, and customers with ease. With API2Cart, you can build a secure SCAPI integration quickly using a single unified API that also connects your app to 80+ other eCommerce platforms at once.
How to integrate with SCAPI API?
You can integrate with the SCAPI API directly, but this approach often requires significant development effort and ongoing maintenance. A faster and more efficient option is to use a ready-made integration solution like API2Cart. It provides a unified API that enables your SaaS to connect with 80+ eCommerce platforms and marketplaces, including SCAPI. This approach saves time, reduces costs, and minimizes technical complexity, allowing your team to focus on core product development instead of maintaining multiple integrations.
What happens if SCAPI updates its API?
If SCAPI updates its API, you don't need to worry when using API2Cart. The service constantly monitors API changes and keeps your integration stable. This means your software or app continues to work smoothly without additional coding, version tracking, or maintenance efforts from your side.
Download Free Integration Guide
Special Salesforce B2C Commerce API (SCAPI) Integration via API2Cart
Fill in your details to get instant access to the Salesforce B2C Commerce API (SCAPI) Integration Guide. Everything you need to know — in one document.
