api orders

note

Preliminary: subject to change

Available APIs:

GET /api/v1/orders/orderSummary (gets list of order summaries)

Parameters

name	type	data type	description
orderCode	optional	string
materialCode	optional	string
toolingCode	optional	string
salesOrder	optional	string
workOrder	optional	string

Responses

http code	content-type	response
200	text/plain;charset=UTF-8	YAML string
400	application/json	{"code":"400","message":"Bad Request"}

Example cURL

 curl -X GET -H "Content-Type: application/json" http://localhost:8080/api/v1/orders/orderSummaries?orderCode=testorder

POST/api/v1/orders/add

GET /api/v1/orders/orderSummary (gets list of order summaries)

Parameters

none

Body

{
    
  "documentID": "string",
  "orderCode": "string",
  "action": "Put",
  "customer": {
    "code": "string",
    "name": "string",
    "address1": "string",
    "address2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "customerInstructions": "string",
    "phone": "string"
  },
  "schedule": {
    "requiredDateTime": "2024-09-17T00:32:11.845Z",
    "shipDate": "2024-09-17T00:32:11.845Z",
    "onHold": true,
    "truckNumber": "string",
    "stagingBay": "string",
    "loadingDock": "string"
  },
  "userData": {
    "user1": "string",
    "user2": "string",
    "user3": "string",
    "user4": "string",
    "user5": "string"
  },
  "products": [
    {
      "toolingDetail": {
        "toolingCode": "string",
        "description": "string",
        "machineNumber": 0,
        "finishedWidth": 0,
        "toolingGroup": "string"
      },
      "materialDetail": {
        "materialCode": "string",
        "description": "string",
        "gauge": 0,
        "thickness": 0,
        "widthIn": 0,
        "color": "string",
        "type": "string",
        "coverIn": 0,
        "lbsPerFt": 0
      },
      "bundles": [
        {
          "bundleNumber": 0,
          "bundleCode": "string",
          "userData": {
            "user1": "string",
            "user2": "string",
            "user3": "string",
            "user4": "string",
            "user5": "string"
          },
          "items": [
            {
              "itemId": "string",
              "quantity": 0,
              "partLengthIn": 0,
              "message": "string",
              "punchPatternName": "string",
              "partOption": "string",
              "userData": {
                "user1": "string",
                "user2": "string",
                "user3": "string",
                "user4": "string",
                "user5": "string"
              },
              "sequence": 0,
              "pieceMark": "string",
              "bundleGroup": "string",
              "stockKeepingUnit": "string",
              "partLabelDef": "string",
              "bundleLabelDef": "string"
            }
          ]
        }
      ],
      "message": "string",
      "workOrder": "string",
      "maxBundleWeightLbs": 0,
      "maxBundlePieceCount": 0,
      "partLabelDef": "string",
      "bundleLabelDef": "string"
    }
  ],
  "importSentToAgent": true,
  "salesOrder": "string",
  "purchaseOrder": "string"
}

Responses

http code	content-type	response
200	text/plain;charset=UTF-8	YAML string
400	application/json	{"code":"400","message":"Bad Request"}

Example cURL

 curl -X GET -H "Content-Type: application/json" http://localhost:8080/api/v1/orders/orderSummaries?orderCode=testorder

DELETE /api/v1/orders/{ordId}