website-logo-mobile
{{headerCtrl.cartNumber > 99 ? '99+': headerCtrl.cartNumber}}

{{"INTEGRATION_WITH_API_MAIN_TITLE"|translate}}

Product API Document

Our products have complex specs,so API docs are provided per product.Please comtact us to get the right documentation.

1.Request API Documentation (Important)

Select the product you'd like to integrate on the product page and contact our team to get the specific API documentation.

user registration
Contact Us
{{"PARTNER_REGISTRATION_TITLE"|translate}}

{{"REGISTRATION_TITLE"|translate}}

user registration

{{"ACTIVATION_TITLE"|translate}}

{{"ACTIVATION_STEP_1"|translate}}

email activation

{{"ACTIVATION_STEP_2"|translate}}

verification email

Dashboard

{{"LOGIN_TITLE"|translate}}

login
{{"STORE_CREATION_TITLE"|translate}}

{{"STORE_CREATION_SUBTITLE_1"|translate}}

create new shop

{{"STORE_CREATION_STEP_2"|translate}}

fill store information

{{"STORE_CREATION_STEP_3"|translate}}

manage store

{{"PRODUCT_SELECTION_SUBTITLE_1"|translate}}

choose product

{{"PRODUCT_SELECTION_STEP_2"|translate}}

product list

{{"PRODUCT_SELECTION_STEP_3"|translate}}

add product

{{"PRODUCT_SELECTION_STEP_4"|translate}}

choose store

{{"PRODUCT_SELECTION_STEP_5"|translate}}

view product
{{"STORE_ORDER_INTEGRATION_TITLE"|translate}}

store order data

{{"STORE_ORDER_INTEGRATION_SUBTITLE_2"|translate}}

{{"STORE_ORDER_INTEGRATION_STEP_2"|translate}}

store order data

{{"STORE_ORDER_INTEGRATION_SUBTITLE_3"|translate}}

store order data
API Store Order Integration

1.Create an order using the API store order interface

Call the QPMN WhiteLabel API store creation interface to generate a retail order with basic customizations of the QPMN WhiteLabel API store.

store order data

2.How to obtain sample data of api store orders

Go to the 'Dashboard' of QPMN WhiteLabel, click on 'My Products' to view the store's product list information, and select a api store, then click the button in the action section of the store's products, click 'API Document'.

store order data

3. Design Data

Design Data indicates what structure to submit when placing an order. It follows the 'DesignSchema' structure, filling in the URL of the image uploaded by the user into the corresponding position to form the data that needs to be submitted when placing an order.

In store product JSON file Modal, design data is in the example data.

store order data
store order data

4. Design Schema

Design Schema describes what materials can be customized for the store's products, how many sides each material has, how many images need to be uploaded for each side, and what processes, image sizes, and formats are supported.

You can click to 'Download Design Schema File' to download the design schema sample data, then convert it to design data according to the design schema conversion specification.

'Design Schema' itself doesn't generate orders; it simply tells us "which customizations should be displayed and how much content is acceptable." When an order is actually placed, the system needs 'Design Data'.

store order data
store order data

It means:
  • - This product has a customizable material: Card;
  • - The card has two customizable sides: the front and the back.
  • - The front requires 54 custom content items, and the back requires 1 custom content item.
  • - Each custom content only supports CMYK technology;
  • - The recommended container size for uploaded images is 2.5 × 3.58 inches, which is approximately 750 × 1074 pixels at 300 DPI.
  • - Allows jpg、png and pdf formats.

    • 5. How to convert the design schema structure into design data in the order?

    Design Schema ↔ Design Data Mapping

    Location in Design SchemaLocation in Design Dataillustrate
    materials[].codedesignData[].codeSame material path Base64 The code is used to identify which material it is.
    materials[].views[].codedesignData[].views[].codeThe code for the same custom face, for example Card_Front、 Card_Back。
    materials[].views[].qtydesignData[].views[].designs.lengthThe Design Schema specifies how many items should be passed to this face, and the number of designs in the Design Data must be consistent with this.
    materials[].views[].effects[].namedesignData[].views[].designs[].effectImages[].effectThe process name must be consistent, for example, CMYK.
    materials[].views[].allowFormatsAffecting the types of files uploaded by usersOnly these formats are allowed to be uploaded.
    materials[].views[].dpi 、
    materials[].views[].effects[].width、 materials[].views[].effects[].height、 materials[].views[].effects[].unit    		Affects the size of user-uploaded imagesThis is used to suggest to users how large an image they should prepare.

    Frequently Asked Questions

    Q: What is the relationship between 'qty' in Design Schema and 'designs' in Design Data?

    'qty' represents the rule, and 'designs' represents the result. In the schema, if a face has 'qty = 54', it means that this face will ultimately submit 54 items; correspondingly, the 'designs' array for that face in the Design Data should have 54 elements.


    Q: How should the 'index' field be filled in for each 'design'?

    'index' is a sequence number starting from 0, indicating which card or custom content item it is. For example, the front of 54 cards should be numbered from 0 to 53.


    Q: What must be filled in for 'effect' in 'effectImages'?

    You must fill in the value corresponding to 'effects[].name' in the Schema. The current products are typically 'CMYK'.


    Q: How large does the uploaded image need to be?

    See 'views[].effects[]' in the Schema:

  • - If 'unit = "inch"', the pixel width and height are 'width × dpi' and 'height × dpi';
  • - If 'unit = "px"', use 'width' and 'height' directly;
  • - The file format must belong to 'allowFormats'.

    • Top Products

    Solutions & Tech

    Platform & Integrations

    Resources & Company