Table of Contents

Work Order

API to submit Work Order. Supported methods are GET.

url: ~/work_order

JSON Schema

Other reference json schema: object_document, object_variance, object_party

{
  "$id": "https://www.igarment.net/schema/json/v1-0/work-order.json",
  "title": "Work Order",
  "type": "object",
  "required": [ "reference", "job_order_ref", "job_style_ref", "processes", "assortments" ],
  "properties": {
      "reference": { "$ref": "object-document.json#/$defs/reference" },  // work order no, issue date, factory code in our system
      "internal":  { "$ref": "object-document.json#/$defs/internal" },
      "pricing":   { "$ref": "object-document.json#/$defs/pricing" },
      "shipping":  { "$ref": "object-document.json#/$defs/shipping" },
      "userdefs":  { "$ref": "object-document.json#/$defs/userdefs" },
      "status":    { "$ref": "object-document.json#/$defs/status" },
      "system":    { "$ref": "object-document.json#/$defs/system" },
      "processes": {
          "type": "array",
          "items": {
              "type": "object",
              "properties": {
                  "code":  { "type": "string", "maxLength": 4 } // process code in our system
              }
          },
          "required": [ "code" ],
          "minItems": 1
      },
      "job_order_ref":  { "type": "string", "maxLength": 14 },
      "job_style_ref":  { "type": "string", "maxLength": 15 },
      "shipment_ref":   { "type": "integer",  "exclusiveMinimum": 0 },
      "contract_ref_no":{ "type": "string", "maxLength": 26 },
      "qty_unit":       { "type": "string", "maxLength": 3 },
      "prc_unit":       { "type": "string", "maxLength": 3 },
      "assortments":    { "$ref": "object-variance.json#/$defs/assortment" },
      "charges": {
          "type": "array",
          "items": {
              "type": "object",
              "properties": {
                  "charge_type":        { "type": "string" }, //charge type code defined in our system
                  "charge_description": { "type": "string" },
                  "charge_amount":      { "type": "number" }
              }
          }, "required": [ "charge_type" ]
      }
  }
}

Attributes can be used in Find method.

document attributes: work_order_no, prod_loc, iss_date, cur, order_no, style, processes, contract_ref_no, status

shipping attributes: etd_date, eta_date, ship_to, ship_term

system attributes: sys_owner, sys_create_date, sys_lm_user, sys_lm_date

Example

GET: ~/work_order/WK17-00242:1

{
"reference": {
  "issue_date": "2017-11-28",
  "party_code": "A-001",
  "no": "WK17-00242:1"
},
"job_order_ref": "BEI-TEST-0002",
"job_style_ref": "STY-03",
"shipment_ref": "",
"internal": {
  "remark": ""
},
"pricing": {
  "cur": "RMB",
  "vat": 0.0,
  "price_inc_vat": false,
  "price_term": "",
  "payment_term": ""
},
"shipping": {
  "ship_method": "",
  "ship_to_warehouse": ""
},
"status": {
  "status_by": "",
  "status_code": ""
},
"system": {
  "owner": "USER",
  "created_user": "USER",
  "created_date": "2017-11-28T14:30:17",
  "last_modified_user": "USER",
  "last_modified_date": "2018-04-03T10:29:41"
},
"contract_ref_no": "",
"qty_unit": "pcs",
"prc_unit": "pcs",
"processes": [
  {
    "process": "CUT"
  }
],
"charges": [
  {
    "amount": 100.0,
    "charge_type": "04",
    "charge_description": "test"
  }
],
"assortments": [
  {
    "color": "BLUE",
    "size": "M",
    "dim3": "",
    "qty": 100.0,
    "price": 1.0
  }
]
}