iGarment Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Shipping Document API (WIP) ======

Supported methods are GET, PUT, POST, DELETE.

**url: ~/shipping_document**

===== JSON Schema =====

Other reference json schema: [[doc_api_obj|object_document]], [[doc_api_style|object_variance]], [[doc_api_party|object_party]]

  {
    "$id": "https://www.igarment.net/schema/json/v1-0/packing_list.json",
    "title": "Packing List",
    "type": "object",
    "properties": {
        "reference":     { "$ref": "object-document.json#/$defs/reference" },
        "customer_info": { "$ref": "object-party.json#/$defs/party" },
        "expter_code":   { "type": "string", "maxLength": 5 },     // Exporter code defined in our system.
        "expter_info":   { "$ref": "object-party.json#/$defs/party" },
        "pricing":       { "$ref": "object-document.json#/$defs/pricing" },
        "system":        { "$ref": "object-document.json#/$defs/system" },
        "credit_letter_no":  { "type": "string" },
        "LICNo":         { "type": "string" },
        "issue_bank":    { "type": "string" },
        "issue_date":    { "type": "string", "format": "date" },
        "ship_by":       { "type": "string" },
        "vessel":        { "type": "string" },
        "on_about_arrive_date": { "type": "string", "format": "date" },
        "port_load":     { "type": "string", "maxlength": 3 },     // port code defined in our system.
        "port_via":      { "type": "string", "maxlength": 3 },     // port code defined in our system.
        "port_disc":     { "type": "string", "maxlength": 3 },     // port code defined in our system.
        "port_dest":     { "type": "string", "maxlength": 3 },     // country code defined in our system.
        "awb_no":        { "type": "string" },
        "approved":      { "type": "boolean" },
        "status":        { "type": "string" },
        // A list of items in packing list
        "items": {
            "type": "array",
            "items": { "$ref": "#/defs/product" }
        },
    },
    "required": [ "reference", "styles" ],
    "$def": {
        //// This specified a packing product.  Product may or may not include
        // details cartons information.
        "product": {
            "type": "object",
            "allOf": [ { "$ref": "#/$defs/style_info" } ],
            "properties": {
                "assortment": { "$ref": "$ref/object_variance/assortment" },
                "cartons": {
                    "type": "array",
                    "items":  { "$ref": "#/defs/carton" },
                },
            },
        },
        // Properties of style
        "style_info": {
            "type": "object",
            "allof": [ { "$ref": "object_variance.json#/$defs/style" } ],
            "properties": {
                "style_id":    {"type": "integer"},
                "origin":      { "type": "string", "maxLength": 3 }, // country code in our system.
                "qty_unit":    { "type": "string", "maxLength": 3 },
                "weight_unit": { "type": "string", "maxLength": 3 },
                "length_unit": { "type": "string", "maxLength": 3 },
                "sales_order_no":  { "type": "string" },
                "customer_ref_no": { "type": "string" },
                "customer_style":  { "type": "string" },
                "ship_no":         { "type": "integer" },
                "lot_ref":         { "type": "string" },
                "label":           { "type": "string" }
            }
        },
        // This specified a carton.
        "carton": {
            "type": "object",
            "properties": {
                "from_ctn": { "type": "integer", "exclusiveMinimum": 0 },
                "to_ctn":   { "type": "integer", "exclusiveMinimum": 0 },
                "pre_pack": { "type": "string" },
                "number_of_pack":   { "type": "integer" },
                "gross_weight":     { "type": "number" },
                "net_weight":       { "type": "number" },
                "net_net_weight":   { "type": "number" },
                "length":           { "type": "string" },
                "width":            { "type": "string" },
                "height":           { "type": "string" },
                "ucc_prefix":       { "type": "string" },
                "pack_assortments": { "$ref": "object-variance.json#/$defs/assortment" }
            }
        }
    }
  }