---
title: "Introduction to the platform onboarding guide"
slug: "introduction"
updated: 2025-09-23T11:45:58Z
published: 2025-09-23T11:45:58Z
canonical: "docs.newstore.com/introduction"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.newstore.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction to the platform onboarding guide

The NewStore Partner Onboarding program is a set of step-by-step tutorials on how to set up the NewStore platform. The modules provide a guideline through basic platform functionality and help you navigate the platform documentation. Each module describes a scenario given to you by a fictitious retail executive and invites you to play with the platform, its config and APIs, and experiment with what is possible.

#### Audience

The NewStore Partner Onboarding program is targeted to

- New System Integrator Partners that are in the process of onboarding into the NewStore Partner program
- Developers onboarding as new Employees into those Partners
- Retailer internal developer teams

#### Content

The modules covered in this area are broken up by OMNI functionality to match typical deployment strategies. These include.

- [Module 1 - Foundational Setup](/v1/docs/module-1-foundational-setup) - This tutorial covers the basics to perform a simple and carry transaction.
- [Module 2: Returns & exchanges](/v1/docs/module-2-returns-exchanges-new) - Covers the setup to enable performing returns and exchanges
- [Module 3: Store inventory management (Part 1)](/v1/docs/module-3) - Introduction to how to set NewStore to manage store on hand inventory
- [Module 4: Web order injection using a sample payment gateway](/v1/docs/module-4-1) - First steps of setting up NewStore as the OMS, enabling the injection of external orders
- [Module 5: Buy Online Pickup In-Store (BOPIS)](/v1/docs/module-5-buy-online-pickup-in-store-bopis) - Setup of the BOPIS capability in NewStore
- [Module 6: Store fulfillment](/v1/docs/module-6-store-fulfillment) - How to use stores as fulfillment locations
- [Module 7: Endless Aisle & Mixed cart](/v1/docs/module-7-endless-aisle-mixed-cart) - Leverage the whole shippable inventory in a region for in store sales
- [Module 8: Promotions and Discount](/v1/docs/module-8-promotions-and-discount) - This tutorial covers the different promotions and discounts supported in NewStore
- [Module 9: Inventory Management (Part 2)](/v1/docs/module-9-inventory-management) - Dive deeper into detailed inventory management transactions in-store.
- [Module 10: AA customization](/v1/docs/module-10-aa-customization) - This tutorial covers the different customization supported in the Associate App customization framework

#### Preparation

Before you start on these modules, please make sure you have the following resources/tools in place.

- A freshly created sandbox environment of the NewStore Platform. Please request a blank system vis your point of contact in NewStore.
- An Apple Business Manager Account (ABM), see the separate document “Application Deployments using ABM”. Alternatively, you can use TestFlight if you don’t have an ABM account. Please reach out to your NewStore point of contact to get the TestFlight details.
- Postman or a similar tool to perform API calls.
- A data storage system that allows you to upload files that can be made available publicly or via a signed URL. (e.g. AWS S3, Google Drive)
- If you are planning to build an integration, then a system enabling you to host and run simple integration applications that respond to a NewStore webhook callback in a defined manner. This could be on GCP, AWS, Boomi, Azure, or any similar platform.
- As you make different API calls, you will need to generate an API Credentials token. Use this [documentation](/v1/docs/loading-master-data#api-authentication-and-access) to create a new credential. Make sure you select the right scope/privilege while creating the API credentials, as you will not be able to modify it later.

> [!NOTE]
> Important
> 
> As you follow the documentation you will see URLs specified as `https://{{tenant}}.newstore.net`. This is only an example. Your URL will replace `{{tenant}}` with the name of your sandbox - such as - `https://partnerenablement-ex.p.newstore.net/`.

#### Feedback

We’d like to encourage you to provide feedback how we can further improve the onboarding modules.