Supplier Introduction

Latest Update Time: 2026-07-02 00:00:00

The Supplier module lets you manage supplier and factory records in QIMA's system. Suppliers must exist in QIMA before you can reference them (via supplierCode) when creating an Inspection, Audit, or Lab Testing order. This module provides full CRUD (create, read, update, delete) for suppliers, plus a factory-confirmation API used during the inspection booking flow.

This page documents the shared setup used by every Supplier guide. Each API-specific guide links back here for authentication, headers, and environment details.

Base URL

All Supplier APIs are served from the QIMA Public API host for your environment:

https://ppapi.qima.com

For production integrations, replace the host with the QIMA API host provided for your environment.

Required Headers

Call the Auth API first (POST /auth/v2/token) before any Supplier request. See the Getting Started Guide or Get Token API for authentication setup.

Header	Location	Source	Description
`Ai-Api-Access-Token`	Request header (all Supplier APIs)	Provided by QIMA	Request source identifier. Each client may have a different value per environment.
`Ai-User-Id`	Request header (all Supplier APIs)	Auth API response `userId`	QIMA client user login ID of the authenticated user.
`Authorization`	Request header (all Supplier APIs)	Auth API access token	Format: `Bearer <access-token>`. Use the token from the same Auth API session as the other headers.
`Referer`	Request header (all Supplier APIs)	Fixed value	`https://preprodmy.qima.com/`

Common Authentication Errors

Status	Meaning	Recommended Action
`401 Unauthorized`	Token or user authentication failed.	Confirm the `Authorization`, `Ai-User-Id`, and `Ai-Api-Access-Token` headers are from the same Auth API session and environment.
`403 Forbidden`	The user does not have access to the requested resource.	Verify account permissions for the target Supplier operation.

Common Response Shape

Every Supplier API wraps its data in the same envelope:

{
  "message": null,
  "content": "... the actual data, shape varies per API ..."
}

Available APIs

API	Method	Endpoint	Guide	API Reference
Create a new supplier	`POST`	`/user/v2/{userId}/supplier`	Create Guide	API Reference
Get supplier details	`GET`	`/user/v2/{userId}/supplier/{supplierId}`	Detail Guide	API Reference
Update a supplier	`PUT`	`/user/v2/{userId}/supplier/{supplierId}`	Update Guide	API Reference
Search suppliers	`GET`	`/user/v2/{userId}/suppliers`	Search Guide	API Reference
Delete one or more suppliers	`DELETE`	`/user/v2/{userId}/suppliers/{supplierIds}`	Delete Guide	API Reference
Confirm inspection date and factory	`PUT`	`/order/v2/{orderId}/factory`	Confirm Factory Guide	API Reference

Integration Workflows

1. Authenticate (Required for All Flows)

2. Create and Manage a Supplier

Step	Guide
Create supplier	Create Guide
Update supplier	Update Guide
Look up existing suppliers	Search Guide
Get full details of one supplier	Detail Guide

3. Factory Confirmation (Inspection Booking Flow)

Use this when a supplier needs to confirm the inspection date, container ready date, and factory details for an order that was booked without full factory information (see Inspection Booking).

Step	Guide
Confirm factory	Confirm Factory Guide

Choosing the Right API

Your goal	Recommended APIs
Register a new supplier before booking orders	Create a Supplier
Look up existing suppliers	Search Suppliers
View full details of one supplier	Get Supplier Details
Change a supplier's information	Update a Supplier
Remove suppliers no longer in use	Delete Suppliers
Confirm factory/inspection details for a booked order	Confirm Inspection Date and Factory

Getting Started Guide — Authentication and first API call
Module Overview — Overview of all QIMA Public API modules
API Reference — Interactive endpoint explorer for all Public APIs

Documents