Connect Home Depot: pull orders in, push fulfillment out
Take the API base URL and API key from your Home Depot supplier onboarding, paste them into Integration, test, map, activate — orders flow in and fulfillment flows back.
The Home Depot connector pulls orders from Home Depot into OMS, and pushes fulfillment back to Home Depot. It can also push product and inventory updates out, so orders, shipping, and stock stay in sync on both sides.
Prerequisites#
- You are a Home Depot supplier and your supplier onboarding is done, so the supplier API has been opened for you.
- You have the API base URL and the API key from that supplier onboarding — both are required to create the connection.
- You know your Home Depot supplier / vendor ID. It is optional and used for reference only, but having it at hand helps you check the connection later.
Get your credentials#
- Open the materials from your Home Depot supplier onboarding and find the supplier API address. That address is your API base URL — copy it exactly as given, starting with https://.
- In the same onboarding materials, find the API key. Copy it in full and keep it somewhere safe — you will paste it into Integration in the next step, and it is sent as the X-API-Key header on every request.
- Note your Home Depot supplier / vendor ID from the same onboarding materials. You only need it as a reference on the connection, so write it down as shown.
Fill it into Integration#
- Open Integration → Connector Marketplace → Home Depot → New connection.
- API base URL: paste the supplier API address from your Home Depot supplier onboarding, in full and exactly as given — for example it starts with https://. This field is required, and it decides where every request goes, so do not shorten it or use an address from somewhere else.
- API key: paste the API key from your Home Depot supplier API onboarding. This field is required. It is sent as the X-API-Key header, encrypted at rest, and never echoed back.
- Supplier ID: enter your Home Depot supplier / vendor ID exactly as it appears in your onboarding materials. This field is optional and for reference only — it labels the connection with your supplier number so you can tell at a glance which supplier it belongs to.
Test the connection#
Click Test connection. The test uses the API base URL and API key you filled in to reach the Home Depot supplier API and check that the key is accepted. A pass means the address was reached and the key works. If it fails, note the error and check the FAQ below before changing anything else.
Mapping / pick a template#
Pick the Home Depot standard template. It maps order number, line SKUs, quantities, ship-to address, and fulfillment status between Home Depot and the standard order. Check the mapping preview before activating, especially that each Home Depot SKU is paired to the right OMS product.
Activate#
After activation, Integration pulls new Home Depot orders on the schedule you set, pushes fulfillment with tracking numbers back to Home Depot, and pushes product and inventory updates out. Watch the first few orders in Runs / Logs before trusting it unattended.
FAQ#
Test fails: the API key is not accepted
The API key in the connection is wrong — for example it was copied incompletely, or it is not the key from your Home Depot supplier API onboarding. The key is sent as the X-API-Key header on every request, so a key Home Depot does not recognize fails at the door every time.
Go back to your Home Depot supplier onboarding materials, copy the API key again in full, and paste it into the API key field in the connection. Save and test again.
Test cannot reach the API at all
The API base URL in the connection is wrong. This field holds the supplier API address from your own Home Depot supplier onboarding — if what you pasted is shortened, mistyped, or an address from somewhere else, requests go to the wrong place or nowhere, and the test fails before the API key is even checked.
Go back to your Home Depot supplier onboarding materials and copy the supplier API address again in full, exactly as given, then replace the API base URL in the connection with it. Save and test again.
The Supplier ID on the connection does not match
The Supplier ID was typed in wrong, so the reference on the connection points to a different supplier number than the one Home Depot gave you in onboarding. The connection can still be saved, but the label is misleading when you check later which supplier the orders belong to.
Check the supplier / vendor ID in your Home Depot supplier onboarding materials and correct the Supplier ID field to match it exactly. If you are not sure of the number, clear the field instead — it is optional and for reference only — then save and test again.
Connected but no orders come in
The connection itself is fine — testing passes — but Home Depot has not issued any new orders for your supplier yet, so there is nothing to pull.
Wait for the next Home Depot order for your supplier, then run a manual pull and check Runs / Logs. New orders appear once Home Depot has issued them.