This guide provides a resources to assist with the development to OnePIM's API.

• For My Marketplace functionalities and other applications see My Marketplace's User Guide
• For all related articles see OnePIM & OnePDX User Guide

Quick Links

• Before Starting: Considerations
• Authentication
• OnePIM API Overview
• Documentation
• API Calls
• Sandbox Environment
• Tips
  • Setting Marketplace Key
  • Setting Supplier Key

Considerations

There are some considerations that must be taken into account before you begin writing your integration. Read the article Considerations Before Integrating to get started.

Authentication

For instructions on how to authenticate on OnePIM's API read this article.

OnePIM API Overview

LBMX provides an API which allows OnePIM and OnePDX users to connect their existing systems. The API allows for read and write functionality:

• Write - Add and update products and assets from an external system to your OnePIM
• Read - Sync your OnePIM products to an external system

Documentation

Our Postman Collection is updated frequently and describes how to use the most common endpoints.

Download Sample Query Postman Collection Here

• Read each folder description for information on the endpoints that folder contains

Our Swagger Documentation is automatically generated by our APIs resulting in the most current version of our documentation available on one platform at all times.

View our PIM API Swagger Documentation Here

API Calls

Security API calls are made to the base URL https://api.lbmxmarketplace.com/security

PIM API calls are made to the base URL https://api.lbmxmarketplace.com/pim

Sandbox Environment

Your account is a sandbox environment until you have created an Outbound Profile for one or more receivers. Nothing you put into your account will affect downstream accounts until this action has been taken. Review the article How do I determine which products go to which trading partners? for more information.

Tips

Setting Marketplace Key

• You are required to set a marketplace to identify which set of suppliers are available send to
• If you are sending products to Supply Cloud use accountKey 15
• If sending to another marketplace (group suppliers) you can query the list of available marketplaces by sending a GET /marketplacepartners/accountrelationship/marketplaces

• Now substitute the 'accountKey’ value into the ‘marketplace’ field in the body of a POST /security/auth/setMarketplace

Setting Supplier Key

• Products and Assets need to be identified by the ‘supplierKey’ that represents the supplier they are associated with
• Send a GET /pim/v2/supplier to get the list of available suppliers and record the ‘accountKey’ in the response as the supplier key

Support

If you have any questions about working with Supply Cloud OnePIM or writing to the OnePIM API, please contact the LBMX Support Team at support@lbmx.com.