With the /orders endpoint user can create the orders from bundle.
POST
/api/Orders/Create
Creates a order
Model Request Example
/api/Orders/Create?bundleUniqueIdentifire=bundleUniqueIdentifire
Response Example
[ "Orders": [ {"Job" : "ETERXYZR1AG"} ] ]
GET
/api/Orders/GetInfo
Get information of order
Request Example
/api/Orders/GetInfo/?OrderType=embroidery-template&TemplateCode=emb-temp OrderType is required If Job is provided, others is optional Else Style or TemplateCode is required
Response Example
{ "OrderId": 0, "Quantity": 1, "Width": 1793, "Height": 3553, "NumStitches": 25250, "NumTrims": 2480, "Left": 7197, "Top": -6174, "Right": 8990, "Bottom": -2621, "Recipe": "Normal", "MachineFormat": "string", "MasterDensity": 40, "Palette": { "$id": "2", "Name": "", "Threads": [ { "Name": "Royal Blue", "Manufacturer": "stirng", "Code": "1134", "Red": 18, "Green": 81, "Blue": 149, "Type": "ttRayon", "Thickness": 3.0 }, .... ] }, "Needles": [ 1 ], "SuitableMachinesForDesigns": null, "PreviewBase64String": "iVBORw0KGgoAAAANSUhEUgAA......", "ThreadPalettes": [ { "Name": "", "Threads": [ { "$id": "22", "Name": "Royal Blue", "Manufacturer": "MADEIRA CL40 CV_VI", "Code": "1134", "Red": 18, "Green": 81, "Blue": 149, "Type": "ttRayon", "Thickness": 3.0 }, .... ] } ] }
POST
/api/Orders/Submit
Submit the order.
Model Request Example
/api/Orders/Submit?{Order Parameter}&{RenderModel-optional} or /api/Orders/Submit?{RenderModel-optional} + json model Order model + RenderModel /api/Orders/Submit?OrderType=embroidery-template&ProductCode=Cap&TemplateCode=emb-temp&Personalizations[0].ElementName=TEXT1&Personalizations[0].Text=PULSE&Personalizations[0].IsText=true&ImageWidth=200&ImageHeight=200&OffsetX=0&OffsetX=0&DPI=300&Padding=10&RenderOnProduct=true&RotationAngle=0 RenderModel + json model /api/Orders/Submit?ImageWidth=200&ImageHeight=200&OffsetX=0&OffsetX=0&DPI=300&Padding=10&RenderOnProduct=true&RotationAngle=0 + { "Job": "string", "ViewInfo": "string", "OrderType": "string", "ProductCode": "string", "TemplateCode": "string", "Quantity": 1, "CustomerName": "string", .... "Personalizations": [ { "ElementName": "string", "IsText": true, "Text": "string", "TextColour": "string", "FontOverride": "", "HeightOverride": "", "Alignment": "", "Case": "(optional) (Std, Upper, SmallUpper, Lower, FirstUpper)", "VerticalSpacing": "", "ItalicAngle": "", "Design": "" }, .... ] } For more details on Orders attributes please refer to Common Order Parameters
Response Example
{ "OrderId": int, "Job": "string", "PxfFileUrl": "string", "PcfFileUrl": "string", "PngFileUrl": "string", "DstFileUrl": "string", "PvFileUrl": "string", "PdfFileUrl": "string", "JpgFileUrl": "string", "HpglFileUrl": "string" }
POST
/api/Orders/SubmitGroupOrder
Submit the group order.
Request Example
/api/Orders/Submit?ImageWidth=&ImageHeight=&OffsetX=0&OffsetX=0&DPI=&Padding=0&RenderOnProduct=false&RotationAngle=
Model Request Example
{ "Address":"string", "Address2":"string", "City":"string", "Country":"string", "Carrier":"string", "Company":"string", "CompanyCode":"string", "CustomerOrderNumber":"string", "CustomerCode":"string", "CustomerEmail":"string", "CustomerGender":"string", "CustomerName":"string", "CustomerTelNumber":"string", "Marketplace":"string", "Package":"string", "PostalCode":"string", "ShippingLabelURL":"string", "ShippingMethod":"string", "State":"string", "TrackingNumber":"string", "Jobs":[ { "ProductCode":"string", "OrderType":"print-design", "Quantity": int, "File":"string", "FileFormat":"png", "Size":"string", "Color":"string", "ProductPreviewURL":"string", "ProductLocation":"string", "PreTreatmentCode":"string" } ] } For more details on Orders attributes please refer to Common Order Parameters
Response Example
If the operation is successful the response will be empty with status code 200
POST
/api/Orders/SubmitFile
Upload a file with basic order parameter such as Job, OrderType and ProductCode
Request must be a multipart/form data.
/api/Orders/SubmitFile Supported file types are following PV, SVG, PXF, DST, TBF, TAJ, 10o, DSB, DAT, TCF, EXP, HUS, JEF, SHV, VIP, VP3, PES10, PES56, PES60, PES70, PES80, PES90, STH, ESC, PCF, EMB, PSF, PTF, and PRJ
Response Example
If the operation is successful the response will be empty with status code 200 otherwise error response with http status code 409
GET
/api/Orders/Render
Render the order
Request Example
/api/Orders/Render?OrderType=embroidery-template&ProductCode=Cap&TemplateCode=emb-temp&Personalizations[0].ElementName=TEXT1&Personalizations[0].Text=PULSE&Personalizations[0].IsText=true &Transparency=#00FFFFFF&ProductLocationID=LocationName&RenderOnProduct=true&Dpi=72 Style or TemplateCode is required Parameters OrderType - String constant (embroidery-template | laser-engraving-template print-template | gravotech-rotary-engraving-template | gravotech-laser-engraving-template | coloreel-template) ProductCode - Code of the Product Personalizations[0].ElementName - Element name from the template Personalizations[0].Text - String Personalizations[0].IsText - either true or false. If element is text element then set to true otherwise false Transparency - # sign followed by a hex ARGB color code (example: #00FFFFFF). The format is #AARRGGBB ProductLocationID - Configured location name for the ProductCode RenderOnProduct - either true or false. To render template on a product set to true otherwise set tot false Dpi - example value 72. (At what DPI templates need to render)
Response Example
returns an image
GET
/api/Orders/GenerateBarCode
Get barcode for job number
Request Example
/api/Orders/GenerateBarCode/?jobNumber=HD2SG3UTDW
Response Example
returns job's barcode as an image
POST
/api/Orders/ConfirmOrder
Confirm the order.
Model Request Example
/api/Orders/ConfirmOrder/?job=job
Response Example
If the operation is successful the response will be empty with status code 200
POST
/api/Orders/Search
Search orders
Field | Required? | Possible values | Description |
---|---|---|---|
Request Model | |||
OrderTypes String |
yes | embroidery,print,engraving,emblem,path | Comma separated list of order types. Supplying this value increases search performance. |
Start int |
no | 0 index based - i.e. 0 is the first record | Paging first record indicator. This is the start point in the current data set. |
Length int |
no | The value will be set to 100 if it was not supplied | Number of records that you would like to get in the current draw. It is expected that the number of orders returned will be equal to this number, unless the server has fewer records to return. |
Search DTSearch |
no | Global Search by multiple fields. Pulse proveds case-insensitive search by following columns: Job, Product Code, Customer Order Number, Style, Design, Template Code, Template Name, Template File, Status, Personalization Text | |
Columns List <DTColumn> |
no | Collection of columns which will be used in ordering. | |
Order List <DTOrder> |
no | Collection of all column indexes and their sort directions. | |
DTSearch | |||
Value String |
no | Search value | |
DTOrder | |||
Column int |
yes | Column to which ordering should be applied. This is an index reference to the columns array of information that is also submitted to the server | |
Dir String |
yes | ASC or DESC | Ordering direction for this column. |
DTColumn | |||
Data String |
yes | CreatedDate, Job, CustomerOrderId, ProductCode, TotalNumberOfPieces, Style, Design, TemplateCode, TemplateName, Status, ProcessedDate, CompletedDate | Column's data source |
Request Example
/api/Orders/Search? orderTypes=embroidery,print& Start=10& Length=25& Search.Value=XPO& Columns[0].Data=CreatedDate& Columns[1].Data=TemplateCode& Order[0].Column=0& Order[0].Dir=DESC& Order[1].Column=1& Order[1].Dir=ASC This example will return 25 orders or less, starting with a 10th order in the filtered results. The records will be ordered in descending order by CreatedDate column and then ordered by TemplateCode in ascending order. Only orders which contain XPO in any searchable field will be returned.
Response Example
{ "allOrdersCount": 107, "recordsFiltered": 55, "recordsReturned": 2, "orders": [ { "Order": { "Exceptions": [], "Personalizations": [ { "Palette": [], "Text": "Pulse", "TextColour": "1146 - Flame Red", "FillColour": null, "StrokeColour": null, "FontOverride": "Museo", "HeightOverride": null, "ElementName": "Text 1", "IsText": true, "Design": null }, { "Palette": [], "Text": "Micro", "TextColour": "1146 - Flame Red", "FillColour": null, "StrokeColour": null, "FontOverride": "Museo", "HeightOverride": null, "ElementName": "Text 2", "IsText": true, "Design": null }, { "Palette": [], "Text": "Emoji_AOK", "TextColour": null, "FillColour": null, "StrokeColour": null, "FontOverride": null, "HeightOverride": null, "ElementName": "Emoji_Bottom", "IsText": false, "Design": null } ], "Job": "NEWDEMO0362", "WorkPacketId": null, "CustomerOrderNumber": "NEWDEMO0362", "OrderDate": null, "ProductCode": "BLUSHRTLC", "Style": null, "Design": null, "TemplateCode": "temp1", "TemplateColourOverride": null, "LineSpacingOverride": null, "DesignSpacingOverride": null, "PrimaryColour": null, "SecondaryColour": null, "TemplateFile": null, "OutputFile": null, "Status": "processed", "IsBlacklistChecked": true, "IsManuallyCreated": false, "CreatedDate": "2018-10-03T15:18:59", "ProcessedDate": "2018-10-03T17:52:43", "SewingDate": null, "CompletedDate": null, "OrderType": "embroidery-template", "LastModifiedDate": null, "Justification": "center" }, "TemplateName": "Template 1" }, { "Order": { "Exceptions": [], "Personalizations": [ { "Palette": [], "Text": "What's Up?", "TextColour": "1146 - Flame Red", "FillColour": null, "StrokeColour": null, "FontOverride": "Museo", "HeightOverride": null, "ElementName": "Text 1", "IsText": true, "Design": null }, { "Palette": [], "Text": "Soo tired...", "TextColour": "1146 - Flame Red", "FillColour": null, "StrokeColour": null, "FontOverride": "Museo", "HeightOverride": null, "ElementName": "Text 2", "IsText": true, "Design": null } ], "Job": "NEWDEMO0394", "WorkPacketId": null, "CustomerOrderNumber": "NEWDEMO0394", "OrderDate": null, "ProductCode": "BLUSHRTLC", "Style": null, "Design": null, "TemplateCode": "temp1", "TemplateColourOverride": null, "LineSpacingOverride": null, "DesignSpacingOverride": null, "PrimaryColour": null, "SecondaryColour": null, "TemplateFile": null, "OutputFile": null, "Status": "processed", "IsBlacklistChecked": true, "IsManuallyCreated": false, "CreatedDate": "2018-10-16T14:41:02", "ProcessedDate": "2018-10-16T14:41:11", "SewingDate": null, "CompletedDate": null, "OrderType": "embroidery-template", "LastModifiedDate": null, "Justification": "center" }, "TemplateName": "Template 1" } ] }
POST
/api/Orders/Update
Update parameters in the order.
Parameters
Request Example
- Job (Required)
- The Job of the Order to lookup
- Attributes (all attributes are optional, but at least one of them must be specified)
- Parameters of the Order that will be updated
- Supported Attributes
- Batch
- The updated Batch number of the Order
- CustomerCode
- The updated Customer Code of the Order
- CustomerOrderNumber
- The updated Customer Order Number of the Order
- Quantity
- The updated Quantity of the Order
- SalesOrderNumber
- The updated Sales Order Number of the Order
- ThreadPalette
- The updated Thread Palette of the Order
POST /api/Orders/Update { "Job": "MYJOBID", "Attributes": { "Batch": "Z900000", // - Optional "CustomerCode": "CC451297", // - Optional "CustomerOrderNumber": "HR5VZQCTARI", // - Optional "Quantity": 4, // - Optional "SalesOrderNumber": "RVYFXJFLFJU", // - Optional "ThreadPalette" : "ThreadPalette" // - Optional } }
Response Example
On success 200 On error, 400 Bad request. With a message explaining the error like "Order 'MYJOBID' not found."
POST
/api/Orders/CancelOrder
Cancel an order
Request Example
/api/Orders/CancelOrder/?job=myJob&delete=false job (Required): The job identifier for the order to be canceled. delete (Optional, Default: false): If true, the order also gets archived (but not fully deleted).
Response Example
If successful, the response will be empty with status code of 200 If failed, the response will be an error list with status code of 404 (Not Found) or 409 (Conflict)
POST
/api/Orders/RefundOrder
Refund an order
Request Example
/api/Orders/RefundOrder/?job=myJob&delete=false job (Required): The job identifier for the order to be refunded. delete (Optional, Default: true): If true, the order also gets archived (but not fully deleted).
Response Example
If successful, the response will be empty with status code of 200 If fail, the response will be an error list with status code of 404 (Not Found) or 409 (Conflict)
POST
/api/Orders/GetOrderDetailsBySession
Returns information about all orders filtered by a specified session
Request Example
/api/Orders/GetOrderDetailsBySession?session=A1B1C1D1
Response Example
{ "Id": 1, "OrderType": "string", "ProductCode": "string", "Design": "string", "ProductLocation": "string", "ViewInfo": "string", "Size": "string", "Quantity": 1, "Personalizations": [ { "Id": 1, "OrderId": 1, "SortOrder": 0, "Text": "string", "TextColour": "string", "FillColour": "string", "StrokeColour": "string", "FontOverride": "string", "HeightOverride": 0, "LineSpacingOverride": 0, "ElementName": "string", "IsText": true, "Design": "string", "DesignColor": "string", "HatchType": 0, "HatchDensity": 0, "HatchAngle": 0, "HatchStrokeWidth": 0, "HatchToolDiameter": 0, "HatchOffset": 0, "HatchPassWidth": 0, "HatchConnectSegmThres": 0, "Alignment": "string", "ItalicAngle": 0, "VerticalSpacing": 0, "Case": "string", "EmblemOrderId": 1, "ElementJustification": "string", "DesignColourOverride": "string", "FitDesign": "string", "XOffset": 0, "IsRainbowText": false, "WidthOverride": 0, "HideFillColour": false, "HideStrokeColour": false, "StrokeWidth": 0, "TextColoreelLibrary": "string", "TextColoreelSwatch": "string", "DesignColoreelLibraryOverride": "string", "DesignColoreelSwatchOverride": "string" } ], "ProductElements": { "Collar": "string", "Sleeve": "string", "Body": "string" } }
POST
/api/Orders/SubmitMultiple
Submit multiple order.
Model Request Example
RenderModel(optional) + json model /api/Orders/Submit?ImageWidth=0&ImageHeight=0&OffsetX=0&OffsetX=0&DPI=72&Padding=0&RenderOnProduct=false + [ { "Job": "string", "ViewInfo": "string", "OrderType": "string", "ProductCode": "string", "TemplateCode": "string", "Quantity": 1, "CustomerName": "string", .... "Personalizations": [ { "ElementName": "string", "IsText": true, "Text": "string", "TextColour": "string", "FontOverride": "", "HeightOverride": "", "Alignment": "", "Case": "(optional) (Std, Upper, SmallUpper, Lower, FirstUpper)", "VerticalSpacing": "", "ItalicAngle": "", "Design": "" }, .... ] }, .... ] For more details on Orders attributes please refer to Common Order Parameters
Response Example
{ "OrderId": int, "Job": "string", "PxfFileUrl": "string", "PcfFileUrl": "string", "PngFileUrl": "string", "DstFileUrl": "string", "PvFileUrl": "string", "PdfFileUrl": "string", "JpgFileUrl": "string", "HpglFileUrl": "string" }
GET
/api/Orders/GenerateBarCode
Return a barcode
Request Example
/api/Orders/GenerateBarCode?jobNumber=Job
Response Example
returns a barcode
GET
/api/Orders/JobList
Return job list
Request Example
/api/Orders/JobList?keyword=a
Response Example
[ "230324a", "230404a", "AAWGFZBUOVS", "CAU2GHRWOX0", "DPPRALJWFRC", "ETJHAMTQJZK", "KQD4QAGEWHC", "OOJAKFRFA", "PYG2CODBIFA", "TDAS1C1BJM" ]
GET
/api/Orders/GetOrderPreview
Return a preview
Request Example
/api/Orders/GetOrderPreview?job=MN4418WRWRW&orderType=embroidery-template
Response Example
return a preview image
GET
/api/Orders/Exists
Return true value if the originalJobName exists
Request Example
/api/Orders//Exists?originalJobName=LPATVUHE6FI
Response Example
Return true value if the originalJobName exists
PATCH
/api/Orders/PatchOrder
Patch an order
Request Example
/api/Orders/PatchOrder job (Required): The job identifier for the order to be updated. All parameters except Job are optional { "Job": "MYJOBNUMBER", "OrderId": 123, // If 'OrderId' is set, it will be used to locate and update the Order. "Params": [ { "ProductCode": "productCode" }, { "TemplateCode": "" }, { "Text": "Text1" // First Text of Personalizations }, { "FontOverride": "Font1" // First Font of Personalizations }, { "Text": "Text2" // Second Text of Personalizations }, { "FontOverride": "Font1" // Seconde Font of Personalizations }, ... ] } Orders Field List (name / data type / max length) Account / string / 100 Address / string / 255 Address2 / string / 255 BackgroundColor /number Backing / string / 45 BarcodeID / string / 45 Batch / string / 45 BorderColor /string/ BundleId / number Carrier / string / 100 CatalogId / number City / string / 200 ClientID / string / 45 Color / string / 255 ColorTheme / string / 45 CompanyCode / string / 255 CompanyId number CompositeOrderFileName / string / 512 Country / string / 255 CustomerCode / string / 255 CustomerCompany / string / 45 CustomerEmail / string / 45 CustomerGender / string / 45 CustomerName / string / 45 CustomerOrderNumber / string / 45 CustomerTelNumber / string / 45 DateOrdered / datetime Delivery_Confirmation / string Description / string / 45 Design / string / 45 DesignSpacingOverride / number ExternalId / string Fabric / string / 45 Facility / string / 45 FCProductCode / string / 45 FCShippingCode / string / 45 FulfillmentCenterId / number GroupOrderID / number InputFileName / string IsBlacklistChecked / bit (1 or 0) IsDeleted / bit (1 or 0) IsEmailSent / bit (1 or 0) IsManuallyCreated / bit (1 or 0) IsPaid / bit (1 or 0) IsPrintWorksheet / bit (1 or 0) IsPrioritized / bit (1 or 0) ItemLocation / string / 45 Job / string / 45 Justification / string / 45 LineSpacingOverride / number LoadedToTheClient / string / 45 LocationJustification / string / 45 LocId / number LocInfo / string MarketId / number MaxNumCharacters / number Message / string / 255 NamesInGroupingNameTapes / string NameTapeEmblemCode / string Notes / string / 2000 OnDemandProductSKU / string OrderDate / datetime OrderDue / datetime OrderType / string / 45 OriginalJobName / string / 255 OutputFile / string Package / string / 255 PathJsonData / string PiecesSewn / number PostalCode / string / 10 PreTreatmentCode / string / 255 PrimaryColour / string ProcessOrder / string ProductCategory / string / 45 ProductCategoryName / string ProductCode / string / 255 ProductionType / string ProductLocation / string / 100 ProductLocationId / string / 100 ProductName / string ProductPreviewURL / string ProductSize / string ProductSKU / string Quantity / number SalesOrderNumber / string / 555 ScaleToFit / bit (1 or 0) SecondaryColour / string Session / string / 255 SewingDate / datetime ShelfNumber / string / 45 ShipBillingMethod / string / 45 ShipBillingZipCode / string / 45 ShipByDate / datetime ShippingLabelURL / string ShippingMethod / string / 255 ShippingMode / string / 45 Size / string / 45 SKU / string / 45 Source / string / 255 State / string / 100 Status / string / 45 StockLocation / string / 100 StoreId / string Style / string / 45 StyleName / string TemplateCode / string / 45 TemplateColourOverride / string / 1020 TemplateFile / string TemplateName / string TemplateOverride / string ThreadPalette / string / 255 TrackingNumber / string / 255 UserDefinedName / string / 45 UserDisplayedHeight / number UserDisplayedWidth / number ViewId / number ViewInfo / string WorkPacketId / number Personalizations Field List (name / data type / max length) Alignment / string / string / Case / string Design / string DesignColor / string / 45 DesignColoreelLibraryOverride / string DesignColoreelSwatchOverride / string DesignColourOverride / string ElementJustification / string ElementName / string / 255 EmblemOrderId / number FillColour / string / 45 FitDesign / string / 45 FontOverride / string / 45 FontOverrideName / string / 255 HatchAngle / number HatchConnectSegmThres / number HatchDensity / number HatchOffset / number HatchPassWidth / number HatchStrokeWidth / number HatchToolDiameter / number HatchType / number HeightOverride / number HideFillColour / bit HideStrokeColour / bit IsRainbowText / bit IsText / bit ItalicAngle / number LineSpacingOverride / number PersonalizationId / number StrokeColour / string / 45 StrokeWidth / number Text / string / 2500 TextColoreelLibrary / string TextColoreelSwatch / string TextColour / string / 45 VerticalSpacing / number WidthOverride / number XOffset / number For more details on Orders attributes please refer to Common Order Parameters
Response Example
{ "OrderId": 27044, "Job": "MYJOBNUMBER" }