Welcome to the Mockup Management API Collection. This collection provides endpoints to:
\nCreate single or multiple mockup request
\nGenerate product line mockups
\nPost alerts on Mockup/ ART / Template orders
\nRetrieve product-related information
\nMost endpoints require a bearer token.
\nYou can obtain it from:
\nOr via the My Accounts page
\nInclude the token in the Authorization header
You can use the Support option in the left menu of the GraphXserver.io site to submit any questions related to the API documentation.
\n2. Generate API Key using GetGraphXServerAPIToken API endpoint.
\nThis API is used to authenticate a user or system and generate a secure access token.
\nCall this endpoint with valid credentials (e.g., username/password, client ID/secret) to obtain an access token. This token authorizes access to secured resources and should be stored securely and passed with each request to authorized APIs.
\nUpon successful authentication, the API returns a token (typically a JWT or bearer token) that must be included in the Authorization header of subsequent requests to access protected endpoints.
All HTTP requests made against the GraphXServer.io API must be authenticated using a valid API Key. To obtain your API key, register at GraphXServer.io.
\nThere are two ways to obtain an API Key:
\nFrom the GraphXServer.io Website
Navigate to the My Account section on the GraphXServer.io website to generate or retrieve your API key.
Using the API
Call the Get API key endpoint to generate an API token.
Step 1. To generate a new api key, go to https://demo.graphxserver.io/, on right top menu, click \"My account\".
\nStep 2. Then scroll down to the Configuration section, and press the \"Generate Token\" button, after setting the password, if not set.
\nRetrieves a list of all available Part IDs associated with a specific product. This API is commonly used to fetch part-level information needed during mockup order creation. A valid authentication token is required.
\nThis endpoint provides a comprehensive list of details for the specified product part ID in the query parameter. It includes information such as product details, part details, views within that part, and location details for each view.
\nRetrieves a list of all suppliers associated with a specified company. Authentication is required via a bearer token.
\nRetrieves a paginated list of products for the specified company. The results are returned 15 products per page. You must provide the company name and the desired page number as query parameters. A valid authorization token is required.
\nRetrieves the list of available views (e.g., front, back, left, right, 3D, etc.) for a specific product part ID. This information is typically used to display different visual representations of a product part in mockup tools. A valid authentication token is required.
\nThis endpoint retrieves the placement coordinates associated with a given product view.
\nThe response includes X and Y position values (and additional placement metadata, if applicable) required for rendering artwork on the product view. These coordinates are used by the mockup generation engine to position designs accurately.
\nRetrieves the mapped location details for a specific product and supplier combination. This API is typically used to identify the production location associated with a supplier for a specific product. A valid authentication token is required.
\nThis endpoint returns a list of all product part IDs associated with the product ID provided in the request object.
\nThis endpoint will provide the product map status for the specified image URL and company name.
\nMap status has 3 values:
\nMapped - when the requested product view is approved.
\nNot Mapped - When the product/view is not present for the requested ImageUrl.
\nIn Progress - When the product view is present for the requested ImageUrl but it is not approved.
\nThis requires the token to be passed, which is generated from the first endpoint.
\nThis endpoint returns list of all the product colors for the company specified.
\nThis requires the token to be passed, which is generated from the first endpoint.
\nThe Product folder contains all endpoints related to retrieving product information required for placing mockup orders. These APIs allow clients to fetch essential product data such as product listings, views, colors, supplier locations and other attributes necessary for presenting and processing mockup
\n","_postman_id":"86184128-02b0-49e7-bb43-4ab780a67cf4"},{"name":"Mockups","item":[{"name":"Create Single Mockup","id":"ecab2971-8057-485c-8d65-dda21bf44fb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tObject\": {\r\n \"CompanyName\": \"Art_Cust1\",\r\n \"mockupRequestType\": \"Standard\", //value can be Standard or Premium\r\n \"PONumber\": \"PO1234\", //not mandatory\r\n \"OutputFileFormat\": \"jpg\", //supported output file formats - jpg,png,jpeg,webp, pdf\r\n \"pdfPageSize\":{\r\n \"height\": 0,\r\n \"width\": 0\r\n },\r\n \"ShowBoundingBox\": true,\r\n \"mockupRequestOrderProduct\": [\r\n {\r\n \"supplierId\": \"50\",\r\n \"ProductPartId\": \"B00445507\",\r\n \"ProductViewId\": 0, //not mandatory\r\n \"mockupRequestOrderProductLocation\": [\r\n {\r\n \"LocationName\": \"Full Front\",\r\n \"artURL\": \"https://graphxserveriodemo.blob.core.windows.net/graphxserverio/GraphXServerIO_2710202506_15_361706AM.gif\",\r\n \"instructions\": \"\", //Optional, but if specified additional art order will be created\r\n \"heightInc\": 5, //Optional\r\n \"widthInc\": 4.5, //Optional\r\n \"decorationMethod\": \"Silk Screen\",\r\n \"effects\": { //effects are optional\r\n \"embroidery\": true,\r\n \"removeBackground\": true // removeBackground only works if embroidery effect is true\r\n }\r\n },\r\n {\r\n \"LocationName\": \"Left Chest\",\r\n \"artURL\": \"https://graphxserveriodemo.blob.core.windows.net/graphxserverio/GraphXServerIO_1002202511_49_290562PM.png\",\r\n \"instructions\": \"\", //Optional, but if specified additional art order will be created\r\n \"heightInc\": 3, //Optional\r\n \"widthInc\": 2.7, //Optional\r\n \"decorationMethod\": \"Silk Screen\",\r\n \"effects\": { //effects are optional\r\n \"embroidery\": false,\r\n \"removeBackground\": false\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.demo.graphxserver.io/api/ProductMockupRequest/GetProductMockupRequestExternal","description":"This endpoint returns a Premium or Standard product mockup for an externally supplied or newly uploaded Art URL.
\nIf the provided ProductPartId or product template does not exist, this endpoint will create the product/product template order in the outsource system.
Requires a Bearer token for authentication, which must be obtained using the Get API Token
\nβ Mockup Order Status Values (Response Parameter)
\nParameter: mockupOrderStatus
Description: Indicates the current processing status of the mockup order.
Mockup Order Status Values:
\nProcessed: The mockup has been successfully generated. All required validations have passed, and the mockup output is available for review or download.
\nIn Process: The mockup request has been successfully received and is currently being processed. This status typically occurs when change instructions are provided for the submitted artwork, requiring additional review or updates before mockup generation can be completed.
\nError: The mockup request could not be processed due to an error. This may occur because of invalid, unsupported configurations, or a processing failure. Error details will be included in the response for further investigation.
\nThis endpoint returns the status and mockup output URL for the specified order.
\nRe-triggers the mockup generation process for the given order.
\nThe endpoint returns the current status of a Mockup order. Possible statuses are as follows:
\nProcessed β The order is completed and the mockup has been successfully generated.
\nIn Progress β Additional ART instructions were provided during mockup generation, and the order is currently being processed to generate the ART.
\nError β An error occurred during the mockup generation process. (Currently on UI there is option to retry on the order)
\nRequires a Bearer token for authentication, which must be obtained using the Get API Token
\nThis endpoint allows you to request multiple mockups of different views of a production using the mockupRequestOrderProductViews object. A mockup output is generated for each specified view.
Returns either a Premium or Standard product mockup for the provided art URL or uploaded art files.
\nIf the specified ProductPartId or product template does not exist, the endpoint will automatically create the product or product template order in the outsource system.
Requires a Bearer token for authentication, which must be obtained using the Get API Token
\nβ Mockup Order Status Values (Response Parameter)
\nParameter: mockupOrderStatus
Description: Indicates the current processing status of the mockup order.
Mockup Order Status Values:
\nProcessed: The mockup has been successfully generated. All required validations have passed, and the mockup output is available for review or download.
\nIn Process: The mockup request has been successfully received and is currently being processed. This status typically occurs when change instructions are provided for the submitted artwork, requiring additional review or updates before mockup generation can be completed.
\nError: The mockup request could not be processed due to an error. This may occur because of invalid, unsupported configurations, or a processing failure. Error details will be included in the response for further investigation.
\nThis endpoint returns the status and mockup output URL for the specified order.
\nRe-triggers the mockup generation process for the specified order.
\nIf a productViewId is provided, the re-trigger is limited to that specific view.
If not provided, the mockup generation will be re-triggered for all views included in the order.
\nThe endpoint returns the current status of a Mockup order. Possible statuses are as follows:
\nProcessed β The order is completed and the mockup has been successfully generated.
\nIn Progress β Additional ART instructions were provided during mockup generation, and the order is currently being processed to generate the ART.
\nError β An error occurred during the mockup generation process. (Currently on UI there is option to retry on the order)
\nRequires a Bearer token for authentication, which must be obtained using the Get API Token
\nThis provides endpoints to generate mockups for specified products and to retrieve the status of mockup generation.
\n","_postman_id":"913d4714-0a07-4331-b2ab-71f938482f67"},{"name":"Product Line Mockups","item":[{"name":"Get All Product Lines","id":"4bcbf3a3-6fb5-4def-8f2b-6f2d11b78b87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.demo.graphxserver.io/api/ProductLine/GetAllProductLines?customerName=Art_Cust1","description":"This endpoint returns a list of all product lines available for the authenticated customer.
\nRetrieves product line data associated with the customer.
\nInclude the bearer token in the Authorization header
Requires a Bearer token for authentication, which must be obtained using the Get API Token.
\nThis endpoint returns product mockups for each of the mapped products from the specified product lines. It also includes externally supplied or newly uploaded Art URLs/files at the specified locations for the order.
\nReturns mockups only for products whose color IDs match those listed in the BaseColorIds field.
Requires a Bearer token for authentication, which must be obtained using the Get API Token
\nThis endpoint returns the status and the corresponding orders generated for the product line mockup request specified in the input body.
\nRetrieves the current status of the product line mockup request.
\nRetriggers the mockup generation process for the given product line mockup order.
\nRequires a Bearer token for authentication, which must be obtained using the Get API Token
\nThis folder contains endpoints to:
\nGenerate mockups for products from the specified product lines
\nRetrieve the status of mockup generation for product line mockup orders
\nUse these endpoints to manage and track bulk mockup requests tied to a specific product line.
\n","_postman_id":"ac54c605-d008-47e9-a2e0-38bcac23de4c"},{"name":"Alerts","item":[{"name":"Post Alert For Mockup Order","id":"48e4eabf-a7a1-4f4f-a492-f9b346c15c78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tObject\": {\r\n \"CompanyName\": \"AK Enterprise\",\r\n \"OutsourcedMockupOrderId\": 88195,\r\n \"Subject\": \"Testing from API - Mockup Order\",\r\n \"Message\": \"Test Message\",\r\n \"AlertAttachmentFiles\": [\r\n {\r\n \"AttachmentURL\": \"https://graphxsourcestore.blob.core.windows.net/graphxsourcecontainer/graphxsource0210202211_57_286269PM.gif\",\r\n \"FileName\": \"TestFile\",\r\n \"FileExtension\": \".gif\"\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.demo.graphxserver.io/api/ProductMockupRequest/PostAlertsForMockupOrder","description":"This endpoint posts an alert to a specific mockup order.
\nPosts an alert message linked to the specified mockup order.
\nAssociates the alert with the mockup order identified by the provided order ID in the payload.
\nEnables tracking and notification of important events or issues related to the mockup order.
\nRequires a Bearer token for authentication, which must be obtained using the Get API Token
\nThis endpoint posts an alert to a specific Template order.
\nPosts an alert message linked to the specified mockup order.
\nAssociates the alert with the Template order identified by the provided order ID in the payload.
\nEnables tracking and notification of important events or issues related to the template order.
\nRequires a Bearer token for authentication, which must be obtained using the Get API Token
\nThis endpoint posts an alert to a specific ART order.
\nPosts an alert message linked to the specified mockup order.
\nAssociates the alert with the ART order identified by the provided order ID in the payload.
\nEnables tracking and notification of important events or issues related to the ART order.
\nRequires a Bearer token for authentication, which must be obtained using the Get API Token
\nThis API retrieves all alerts associated with a specific Mockup order.
\nReturns a list of all alerts linked to the order identified by the provided order ID.
\nRequires a Bearer token for authentication, which must be obtained using the Get API Token
\nThis API retrieves all alerts associated with a specific Template order.
\nReturns a list of all alerts linked to the order identified by the provided order ID.
\nRequires a Bearer token for authentication, which must be obtained using the Get API Token
\nThis API retrieves all alerts associated with a specific ART order.
\nReturns a list of all alerts linked to the order identified by the provided order ID.
\nRequires a Bearer token for authentication, which must be obtained using the Get API Token
\nThis endpoints can be used for getting alerts posted on the mockups and also we can post alerts on template, art and mockup orders.
\n","_postman_id":"d826f0be-3d5d-4415-89db-2cfc36219266"},{"name":"VP External","item":[{"name":"Get Proof Templates","event":[{"listen":"test","script":{"id":"e623aaad-a376-44be-b48a-7c83560234ee","exec":[""],"type":"text/javascript","packages":{}}}],"id":"3aa88fbf-f851-42e6-9d61-ce3417713bcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tObject\":{\r\n \"companyName\":\"Art_Cust1\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.demo.graphxserver.io/api/GenerateProofPDF/GetListOfProofTemplates","description":"π Description:
\nThis endpoint allows you to retrieve a list of proof templates associated with a specific company.
\nπ Functionality:
\nSend a POST request with the required input (e.g., CompanyName) to retrieve template data.
The response includes a list of templates containing details such as:
\nTemplateID
TemplateName
Other relevant metadata (e.g., creation date, description, etc.
\nRequires a Bearer token for authentication, which must be obtained using the Get API Token
\nEnsure that the companyName provided in the request is valid and corresponds to an existing company in the system.
The response will contain an array of proof templates, which may vary based on the company specified.
\nIf there are no templates available for the specified company, the data array may be empty.
π Description:
\nThis endpoint allows users to fetch the JSON representation of a proof template using the provided Template ID and Company Name.
\nπ Functionality:
\nRetrieves the structure and data of the proof template in JSON format.
\nRequires TemplateID and CompanyName as input parameters.
Useful for previewing or rendering proof templates dynamically.
\nRequires a Bearer token for authentication, which must be obtained using the Get API Token
\nEnsure that the iNDDTemplateID is provided correctly to retrieve the desired template.
The response fields may vary based on the success or failure of the request, but typically will return a status and any relevant error information if applicable.
\nπ Description:
\nThis endpoint allows users to generate a virtual proof order using the format and structure defined in the provided template.
\nπ Functionality:
\nCreates a virtual proof that mirrors the layout and content of the selected template.
\nUseful for previewing how the final proof will appear before actual order creation.
\nEnsures consistency with the template design during proof generation.
\nRequires a Bearer token for authentication, which must be obtained using the Get API Token
\n