wuxus_json_guide.json

{
    "version": {
        "$type": "string"
    },
    "data": [
        {
            "contractKey": {
                "$type": "string",
                "$comments": "The id of the contract between our company and the reciever"
            },
            "order": {
                "orderNumber": {
                    "$type": "string",
                    "$comments": "Your own ordernumber",
                    "$required": true
                },
                "requisition": {
                    "$type": "string",
                    "$comments": "Any relevant requisition number, fx your customers own ordernumber"
                },
                "orderType": {
                    "$type": "string",
                    "$enum": ["adhoc", "distribution"],
                    "$comments": "Can only be adhoc or distribution",
                    "$required": true
                },
                "pickuped": {
                    "$type": "boolean",
                    "$comments": "True if order has been picked up, for further information look in the documentation at https://docs.wuxus.com" },
                "price": {
                    "amount": {
                        "$type": "number",
                        "$comments": "The price is the provided in the currency's smallest unit. Fx $100 USD should be the value of 10000 (10000 cents)"
                    }
                },
                "paidBy": {
                    "$type": "string",
                    "$comments": "Used for basic payer information"
                },
                "origin": {
                    "companyName": {
                        "$type": "string"
                    },
                    "attention": {
                        "$type": "string"
                    },
                    "address": {
                        "$type": "string",
                        "$comments": "Specific street address (streetname + housenumber).",
                        "$required": true
                    },
                    "extraInfo": {
                        "$type": "string",
                        "$comments": "Used for extra address information such as 'Gate 5' or '2nd floor'."
                    },
                    "zipCode": {
                        "$type": "string",
                        "$required": true
                    },
                    "city": {
                        "$type": "string",
                        "$required": true
                    },
                    "countryCode": {
                        "$type": "string"
                    },
                    "email": {
                        "$type": "string"
                    },
                    "phone": {
                        "prefix": {
                            "$type": "number"
                        },
                        "number": {
                            "$type": "number"
                        }
                    },
                    "timeWindow": {
                        "start": {
                            "$type": "string",
                            "$comments": "Should be an ISO date in UTC format (ISO 8601)"
                        },
                        "end": {
                            "$type": "string",
                            "$comments": "Should be an ISO date in UTC format (ISO 8601)"
                        },
                        "timeType": {
                            "$type": "string",
                            "$enum": ["anytime", "before", "after", "between"],
                            "$default": "between",
                            "$comments": "If 'start' is set, and not 'end', the value should be 'after' or 'anytime'. If 'end' is set, and not 'start', the value should be 'before'. If both 'start' and 'end' is set, the value should be 'between'"
                        },
                        "lock": {
                            "$type": "boolean",
                            "$comments": "Set to 'true' to highlight the timewindow for drivers and dispatchers."
                        }
                    },
                    "comments": {
                        "$type": "string"
                    }
                },
                "destination": {
                    "companyName": {
                        "$type": "string"
                    },
                    "attention": {
                        "$type": "string"
                    },
                    "address": {
                        "$type": "string",
                        "$comments": "Specific street address (streetname + housenumber).",
                        "$required": true
                    },
                    "extraInfo": {
                        "$type": "string",
                        "$comments": "Used for extra address information such as 'Gate 5' or '2nd floor'."
                    },
                    "zipCode": {
                        "$type": "string",
                        "$required": true
                    },
                    "city": {
                        "$type": "string",
                        "$required": true
                    },
                    "countryCode": {
                        "$type": "string"
                    },
                    "email": {
                        "$type": "string"
                    },
                    "phone": {
                        "prefix": {
                            "$type": "number"
                        },
                        "number": {
                            "$type": "number"
                        }
                    },
                    "timeWindow": {
                        "start": {
                            "$type": "string",
                            "$comments": "Should be an ISO date in UTC format (ISO 8601)"
                        },
                        "end": {
                            "$type": "string",
                            "$comments": "Should be an ISO date in UTC format (ISO 8601)"
                        },
                        "timeType": {
                            "$type": "string",
                            "$enum": ["anytime", "before", "after", "between"],
                            "$default": "between",
                            "$comments": "If 'start' is set, and not 'end', the value should be 'after' or 'anytime'. If 'end' is set, and not 'start', the value should be 'before'. If both 'start' and 'end' is set, the value should be 'between'"
                        },
                        "lock": {
                            "$type": "boolean",
                            "$comments": "Set to 'true' to highlight the timewindow for drivers and dispatchers."
                        }
                    },
                    "comments": {
                        "$type": "string"
                    }
                },
                "sender": {
                    "companyName": {
                        "$type": "string"
                    },
                    "attention": {
                        "$type": "string"
                    },
                    "address": {
                        "$type": "string",
                        "$comments": "Specific street address (streetname + housenumber)."
                    },
                    "extraInfo": {
                        "$type": "string",
                        "$comments": "Used for extra address information such as 'Gate 5' or '2nd floor'."
                    },
                    "zipCode": {
                        "$type": "string"
                    },
                    "city": {
                        "$type": "string"
                    },
                    "countryCode": {
                        "$type": "string"
                    },
                    "email": {
                        "$type": "string"
                    },
                    "phone": {
                        "prefix": {
                            "$type": "number"
                        },
                        "number": {
                            "$type": "number"
                        }
                    },
                    "comments": {
                        "$type": "string"
                    }
                },
                "receiver": {
                    "companyName": {
                        "$type": "string"
                    },
                    "attention": {
                        "$type": "string"
                    },
                    "address": {
                        "$type": "string",
                        "$comments": "Specific street address (streetname + housenumber)."
                    },
                    "extraInfo": {
                        "$type": "string",
                        "$comments": "Used for extra address information such as 'Gate 5' or '2nd floor'."
                    },
                    "zipCode": {
                        "$type": "string"
                    },
                    "city": {
                        "$type": "string"
                    },
                    "countryCode": {
                        "$type": "string"
                    },
                    "email": {
                        "$type": "string"
                    },
                    "phone": {
                        "prefix": {
                            "$type": "number"
                        },
                        "number": {
                            "$type": "number"
                        }
                    },
                    "comments": {
                        "$type": "string"
                    }
                },
                "customFields": {
                    "$type": "object"
                }
                "cargo": [{
                    "cargoReference": {
                        "$type": "string",
                        "$comments": "Specific item reference to your own system."
                    },
                    "cargoNr": {
                        "$type": "string",
                        "$comments": "Cargo-type id in your own system."
                    },
                    "description": {
                        "$type": "string"
                    },
                    "type": {
                        "$type": "string",
                        "$enum": ["pallet", "cage", "box", "colli"],
                        "$comments": "Can only be pallet, cage, box or colli",
                        "$required": true
                    },
                    "amount": {
                        "$type": "number",
                        "$comments": "There should be at least one cargo line with a positive number, others can be 0. For further information look in the documentation at https://docs.wuxus.com",
                        "$required": true
                    },
                    "weight": {
                        "$type": "number",
                        "$comments": "The weight is in kilograms (kg)"
                    },
                    "volume": {
                        "$type": "number",
                        "$comments": "The value is in cubicmeters (m3)"
                    },
                    "dimensions": {
                        "height": {
                            "$type": "number",
                            "$comments": "The height is in centimeters (cm)"
                        },
                        "width": {
                            "$type": "number",
                            "$comments": "The width is in centimeters (cm)"
                        },
                        "length": {
                            "$type": "number",
                            "$comments": "The length is in centimeters (cm)"
                        }
                    },
                    "barcode": {
                        "$type": "string"
                    },
                    "services": [{
                        "serviceId": {
                            "$type": "string",
                            "$comments": "Look in the documentation at https://docs.wuxus.com for possible values"
                        }
                    }]
                }]
            }
        }
    ]
}