Welcome to the GraphXSource API collection. This API collection enables seamless integration with the Graphxsource system for managing orders and related processes. The key functionalities include:
\nCreate orders: Submit new orders into the Graphxsource system.
\nCheck order status: Retrieve real-time status updates for submitted orders.
\nGet completion details: Access detailed information on orders upon completion.
\nPlace alerts or queries: Add alerts or queries to orders when revisions are required or additional information is needed.
\nCustomer API configuration: Configure customer-specific APIs to:
\nSend notifications on order completion.
\nNotify customers about file availability for download.
\nInform customers when revisions requested on orders are fulfilled by the artist.
\nThese APIs support automation of order workflows, ensure timely communication, and help track order progress efficiently.
\nπ Description:
\nThis endpoint generates an authentication token that is required for all subsequent API requests. The token is created using the same username and password credentials as used for logging into the Graphxsource system.
\nπ Functionality:
\nAccepts valid system username and password in the request body.
\nReturns a bearer token upon successful authentication.
\nThe token must be included in the Authorization header of all API requests
π Description:
\nThis endpoint provides the Embroidery Template Name and Template ID for the specified customer. The response includes both customer-specific templates and corporate templates.
\nπ Functionality:
\nReturns a list of embroidery templates linked to the provided customer name.
\nIncludes both customer templates and corporate templates in the result.
\nNo authorization token is required to access this endpoint.
\nπ Description:
\nThis endpoint provides the Artwork Template Name and Template ID for the specified customer. The response includes both customer-specific templates and corporate templates.
\nπ Functionality:
\nReturns a list of artwork templates linked to the provided customer name.
\nIncludes both customer templates and corporate templates in the result.
\nNo authorization token is required to access this endpoint.
\nπ Description:
\nThis endpoint provides the Color Seperation Template Name and Template ID for the specified customer. The response includes both customer-specific templates and corporate templates.
\nπ Functionality:
\nReturns a list of Color Sep templates linked to the provided customer name.
\nIncludes both customer templates and corporate templates in the result.
\nNo authorization token is required to access this endpoint.
\nπ Description:
\nThis endpoint provides a list of Master Data IDs that can be used when placing an embroidery order to specify the values for additional parameters.
\nπ Functionality:
\nReturns IDs and corresponding values for the following parameters:
\nThread Manufacturer
\nEmbroidery Stitch Format
\nStart and Exit Point
\nFabric Type
\nFabric Color
\nOnly a Bearer token is required for authorization.
\nπ Description:
This endpoint is used to create new embroidery orders or rework embroidery orders in the system.
π Functionality:
\nβ New Orders
\nTo create a new embroidery (EMB) order, the following parameters are required:
\nTemplateID
DesignName
AttachmentBase64 or AttachmentURL
FileName
FileExtension
CustomerUserName
β Rework Orders
\nTo create a rework embroidery order, the following parameters are required:
\nCustomerUserName
OriginalOrder
The system will automatically use design information from the specified original invoiced order.
\nRework orders can only be placed against invoiced orders.
\nβ Promo Code
\nThe optional PromoCode parameter can be used to apply valid promotions.
Possible validation messages if the promo code is invalid:
\nNot a valid Promotion code.
\nEither the promotion code is not enabled or it has expired.
\nThe promotion code is not valid for Embroidery order.
\nThe usage count limit for this website is over. You cannot use this promotion code.
\nThe promotion code supplied is not applicable to your pricing method.
\nβ Credit Card Validation
\nIf the userβs credit card is expired, the system will not allow the order to be placed.
\nA relevant validation message will be returned in the response.
\nβ PO Number Requirement
\nβ Additional Parameters (Master Data IDs)
\nThreadManufacturerIDs, EmbStichFormatID, StartAndExitPointID, FabricColorID: Use valid IDs from the Get Master Field IDs endpoint.
FabricTypeIDs: Up to three IDs can be passed in this parameter.
Users can request a mockup as an add-on within an Embroidery order.
\nWhen this add-on is enabled, product details are mandatory and must be provided in the request payload. These details will be used to generate the mockup using the production-ready embroidery files.
\nKey Notes:
\nMockup generation is supported only when the mockup add-on is set to true.
ProductDetails must be included to ensure accurate mockup creation.
The mockup will be generated based on finalized production files.
\nπ Description:
The CreateArtworkOrder API is used to create new artwork orders or place rework orders with order type = Artwork/ Creative Art / DTF
π Functionality:
\nTo create a new artwork order, the following parameters are required:
\nTemplateID
DesignName
AttachmentBase64 (or AttachmentURL)
FileName
FileExtension
CustomerUserName
β Note:
\nIf the service level type is not set in the template, the API will return a validation error in the response.
\nTo place a rework order, the following parameters are required:
\nCustomerUserName
OriginalOrder
β Important:
\nThe application will always use the design information from the specified OriginalOrder.
A rework order can only be placed against an invoiced original order.
\nYou can apply a valid promotion using the PromoCode parameter.
If the promotion code is invalid, you may receive one of the following validation messages:
\nNot a valid Promotion code.
Either the promotion code is not enabled or it has expired.
The promotion code is not valid for Artwork order.
The usage count limit for this website is over. You cannot use this promotion code.
The promotion code supplied is not applicable to your pricing method.
If the credit card is expired, the API will not allow you to place the order and a relevant validation message will be returned in the response.
\nIf the PO Number is mandatory for the user:
\nπ Description:
\nThe CreateColorSepOrder API is used to create new orders or place rework orders with order type = Color Sep.
π Functionality:
\nTo create a new Color Sep order, the following parameters are required:
\nTemplateID
ProjectName
CustomerUserName
TypeAndColorOfSubstrateToBePrintedOn
β Multiple Locations:
\nYou can create a Color Sep order with multiple locations.
\nTemplateID is mandatory for each location.
In case of multiple locations, the Preferred Delivery and Add Ons will be taken from the Order Profile set for location 1.
\nTo place a rework order, the following parameters are required:
\nCustomerUserName
OriginalOrder
LocationNumber
ReworkInstruction
β Important:
\nThe application will always use the design information from the specified OriginalOrder.
A rework order can only be placed against an invoiced original order.
\nπ Description:
\nThis request allows you to upload additional files to an existing order in the system. It is useful when file attachments were missed during the original Create Order request.
\nπ Functionality:
\nAccepts additional file attachments for an existing order.
\nAssociates the uploaded files with the specified order.
\nEnsures that the order has all necessary files for processing.
\nCan be called multiple times to add more files as needed until order gets complete
\nπ Description:
\nThis call provides the current status of an order along with any alert details associated with that order.
\nπ Functionality:
\nReturns the current status of the specified order.
\nIncludes alert details if any alerts exist for the order.
\nFor orders with Invoiced status:
\nPossible Order Status values:
\nOrder Screening
Additional Info Required
Assigned to Artist
Quality Check
Ready for Delivery
Invoiced
π Description:
\nThis API provides the completed files for the specified Order ID.
\nπ Functionality:
\nReturns a list of completed files for the order.
\nEach file includes:
\nA downloadable blob URL
\nThe actual filename
\nThe file extension
\nFor embroidery orders, the response also includes:
\nColor information
\nStitch count
\nπΒ Description:
\nThis API allows the customer to post an alert on any order.
\nπΒ Functionality:
\nEnables customers to submit an alert linked to a specific order.
\nSupports adding attachments to the alert.
\nπΒ Description:
\nThe system will notify the customer whenever an artist places an alert on their order.
\nπΒ Functionality:
\nThe system sends an update to the customer-provided endpoint each time an artist posts an alert on the order.
\nThe update includes relevant alert details, such as the alert subject, message, and associated order reference number.
\nThe customer must provide a valid endpoint URL to receive these artist alert updates.
\nπΒ Description:
\nThe system will notify the customer once an order is completed and the files are ready for download.
\nπΒ Functionality:
\nThe system sends an update to the customer-provided endpoint when the order reaches completion.
\nThe update includes relevant order details (e.g., order reference number, completion status, download information).
\nThe customer must provide a valid endpoint URL to receive these notifications.
\nπΒ Description:
\nThe system will notify the customer once a revision requested on a completed order has been processed and finalized.
\nπΒ Functionality:
\nThe system sends an update to the customer-provided endpoint when the revision is completed.
\nThe update includes details such as the order reference number, revision status, and any completed file information (if applicable).
\nThe customer must provide a valid endpoint URL to receive these revision completion updates.
\nThis folder contains APIs that allow customers to register their callback URLs / webhook endpoints.
\nOur system will send automated notifications to these URLs when key actions occur, such as:
\nOrder completion
\nStaff alert posted on the order
\nRevision request completion
\nβ οΈ Note: Customers are responsible for providing and managing these endpoints. Ensure that the URLs are reachable and secured (e.g. HTTPS) to receive timely updates.
\n","_postman_id":"8b1e1205-48da-4282-8a75-ec611c43b8c8"}]}