{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1aa57672-2c56-489c-a4b9-c8ad2144a894","name":"OnPrintShop GraphQL API","description":"Welcome to OnPrintShop's API Documentation. We've designed this document to help developers and OnPrintShop's users fully understand and integrate our API for a seamless and easy deployment.\n\nWe've listed all the APIs, their required parameters, and their example requests and responses on the right for easy understanding. The easiest way to start using the OnPrintShop APIs is by clicking the **Run in Postman** button above. The [Postman](https://www.getpostman.com/) is a free tool that helps developers run and debug API requests.\n\nRead through the following sections for the integration process.\n\n# Getting Started\n\nFirst, you need to activate the GraphQL API, for this you have to contact our support team. After the successfully activation of GraphQL API you can find your Client Credentials and API End Point URL from the OnPrintShop Admin panel.\n\n# Document and API Usage Guidelines\n\n- Our APIs use the basic HTTP request method: _POST_\n- You can import and test all our full API collection in the Postman app by clicking on the **' Run in Postman'** button.\n- **Note**: Any requests made using the valid API credentials will affect the real-time data in your OnPrintShop account.\n- Authorization: Bearer\n- All the APIs are provided with their appropriate example requests and responses for successful and failed calls.\n    \n\n# Errors and Response codes\n\nWhile using OnPrintShop's APIs, you may run into some standard response and error codes. The most common ones are listed along with their descriptions as follows:\n\n| **RESPONSE CODE** | **DESCRIPTION** |\n| --- | --- |\n| `200` - **OK** | Everything worked as expected, and you'll get a response. Some APIs may respond with an error message if data is invalid. |\n| `400` - **Bad Request** | The request was invalid or cannot be otherwise served. |\n| `401` - **Unauthorized** | There is some error during validation. You need to check your token or credentials. |\n| `404` - **Not Found** | The URI requested is invalid or the resource requested does not exist. |\n| `429` - **Too Many Requests** | You have exceeded the API call rate limit. |\n| `500`, `502`, `503`, `504` - **Server Errors** | Some server error has occurred. Some APIs may show this due to syntax or parameter errors. Try contacting support if this persists. |\n\n# API Rate Limiting\n\nTo ensure fair usage and optimal performance for all users, our API employs rate limiting. Below is a detailed explanation of the rate limit policy and how it affects your usage.\n\n- **Rate Limit Policy**\n    - **Request Limit**: Each user can make up to **120 requests**.\n    - **Time Window**: The limit applies to a rolling window of **1 minute**.\n- **How Rate Limiting Works**\n    - **Counting Requests**: Every request you make to the API counts towards your request limit.\n    - **Time Frame**: The rate limit resets every minute. For example, if you start making requests at 10:00:00 AM, your limit will reset at 10:01:00 AM.\n\n# Pagination\n\nWhen you request data from our API, sometimes there might be too much information to handle all at once. To make it easier to view and manage this data, we use a method called \"pagination.\" This means breaking the data into smaller, more manageable chunks or pages.\n\nWe are using Limit and Offset based pagination\n\n### **Key Terms**\n\n- **Limit**: This is the maximum number of items you want to see on one page.\n- **Offset**: This tells you where to start from in the list.\n    \n\n### How to Use Limit and Offset\n\nFor example, you have a large list of items, like 100 records, and you want to view them 10 at a time. Here’s how you can do it:\n\n- **View the First Page**\n    - **Limit**: 10 (you want to see 10 items)\n    - **Offset**: 0 (you start from the beginning)\n- **View the Second Page**\n    - **Limit**: 10 (still want to see 10 items)\n    - **Offset**: 10 (skip the first 10 items and start from the 11th)\n\n### Using Total Records\n\nWhen you request data, the API response also includes the total number of items available. This helps you understand how many pages you can navigate through.\n\nFor example, if the total number of records is 100 and you’re viewing 10 items per page:\n\n- You’ll have 10 pages in total.\n- The first page will have items 1 to 10, the second page will have items 11 to 20, and so on.\n    \n\n### Help: Default and Maximum Records Limit\n\nAdmin can configure the Max Records Limit **(Upto 250)** from the Export/API Settings -> Advanced API section of OnPrintShop\n\n- **Default Records Limit**\n    - If no `limit` parameter is passed in the API request, the system will return a default of 250 records.\n- **Maximum Records Limit**\n    - The maximum number of records that can be returned in one API call is 250. If a `limit` parameter greater than 250 is passed, the system will still return a maximum of 250 records.\n\n# Authentication Token Generation\n\nBy using your Client Credentials you can generate the access token to access the API. For token generation you have to use our [Authentication API](https://documenter.getpostman.com/view/17600430/2sA2xjzBAU#740b7145-ed43-4ec9-a03f-48230ffcccc4)\n\n# API Collection\n\nWe offer following API services:\n\n- **Authentication API**\n    - [Generate OAuth2.0 Token](https://documenter.getpostman.com/view/17600430/2sA2xjzBAU#740b7145-ed43-4ec9-a03f-48230ffcccc4)\n- **Mutations**\n    - [Update Order Status](https://documenter.getpostman.com/view/17600430/2sA2xjzBAU#29a57930-ed48-4e9a-a02c-cca1f0ad8cda)\n    - [Update Product Stock](https://documenter.getpostman.com/view/17600430/2sA2xjzBAU#e8206ec2-9f02-4f4a-b334-47162ed7bfc0)\n- **Queries**\n    - [Customers](https://documenter.getpostman.com/view/17600430/2sA2xjzBAU#06118602-faff-418d-b802-1c7608b8755b)\n    - [Customer Address Details](https://documenter.getpostman.com/view/17600430/2sA2xjzBAU#04fa0df6-9f37-47a2-a626-bb85e3178073)\n    - [Orders](https://documenter.getpostman.com/view/17600430/2sA2xjzBAU#df4a04d5-2859-4642-ad75-f6a98a32c3c9)\n    - [Order Details](https://documenter.getpostman.com/view/17600430/2sA2xjzBAU#6581de2f-fed9-45e3-9051-5eea339eb6ef)\n    - [Order Shipment Details](https://documenter.getpostman.com/view/17600430/2sA2xjzBAU#c241c56d-f569-43e9-afd8-a6bbfaa8cd4a)\n    - [Ship To Multiple Address](https://documenter.getpostman.com/view/17600430/2sA2xjzBAU#4f70f3d4-d988-4f55-88c2-569365c698dc)\n    - [Order and Order Product Statuses](https://documenter.getpostman.com/view/17600430/2sA2xjzBAU#bb1fdb88-6728-48c6-b421-23311d7c4b87)\n    - [Products](https://documenter.getpostman.com/view/17600430/2sA2xjzBAU#fcc0f609-16cb-4b24-ba63-9e46f968fd9a)\n    - [Product Stocks](https://documenter.getpostman.com/view/17600430/2sA2xjzBAU#25a778a9-cc16-4aa4-8452-9cad678306c1)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"33263100","team":14297256,"collectionId":"1aa57672-2c56-489c-a4b9-c8ad2144a894","publishedId":"2sBXijHWys","public":true,"publicUrl":"https://documenter-api.postman.tech/view/33263100/2sBXijHWys","privateUrl":"https://go.postman.co/documentation/33263100-1aa57672-2c56-489c-a4b9-c8ad2144a894","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.12","publishDate":"2026-03-20T13:12:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/96e31cdbcb8a99a91b5c04dbf34856125ccabd1e300879e2e63f8146488f4651","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBXijHWys"}