carton-consignment-waybill-pack-list

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['packing_list', 'label', 'tare_grams'], 'properties': {'note': {'type': 'string', 'maxLength': 2000}, 'label': {'type': 'string', 'maxLength': 200, 'description': 'What is written on the box, e.g. Box 1 of 3 or Pallet A'}, 'width_cm': {'type': 'integer', 'maximum': 2000, 'minimum': 1, 'description': 'Outer width in whole centimetres'}, 'height_cm': {'type': 'integer', 'maximum': 2000, 'minimum': 1, 'description': 'Outer height in whole centimetres'}, 'length_cm': {'type': 'integer', 'maximum': 2000, 'minimum': 1, 'description': 'Outer length in whole centimetres. All three dimensions or none'}, 'tare_grams': {'type': 'integer', 'maximum': 100000000, 'minimum': 0, 'description': 'The EMPTY carton with its packaging, in whole grams. 0 when it is not known'}, 'packing_list': {'type': 'string', 'maxLength': 200, 'description': 'The packing list id, e.g. PL-2026-0001, or the order reference when only one list carries it'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['packing_list'], 'properties': {'divisor': {'type': 'integer', 'description': 'Volumetric divisor in cm3 per kg: 5000 courier air (default), 6000 IATA air, 4000 some road tariffs'}, 'packing_list': {'type': 'string', 'maxLength': 200, 'description': 'The packing list id, e.g. PL-2026-0001, or the order reference when only one list carries it'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['key'], 'properties': {'key': {'type': 'string', 'description': 'License key from checkout, MCPL1.<payload>.<signature>'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {}}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['packing_list', 'description', 'quantity'], 'properties': {'sku': {'type': 'string', 'maxLength': 64, 'description': 'Stock code, upper-cased and stripped of spaces. Lines with a SKU are matched on it, lines without on their description'}, 'quantity': {'type': 'integer', 'maximum': 1000000, 'minimum': 1, 'description': 'How many units the order says should ship. Whole units'}, 'description': {'type': 'string', 'maxLength': 2000, 'description': 'The goods as the order names them, e.g. Oak shelf 900mm'}, 'packing_list': {'type': 'string', 'maxLength': 200, 'description': 'The packing list id, e.g. PL-2026-0001, or the order reference when only one list carries it'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['reference', 'consignee'], 'properties': {'date': {'type': 'string', 'maxLength': 10, 'description': 'The day the list was raised, YYYY-MM-DD. Default today'}, 'note': {'type': 'string', 'maxLength': 2000}, 'ship_to': {'type': 'string', 'maxLength': 2000, 'description': 'The delivery address, printed on the slip. Omit to leave it off'}, 'consignee': {'type': 'string', 'maxLength': 200, 'description': 'Who receives the goods, as named on the order'}, 'reference': {'type': 'string', 'maxLength': 64, 'description': 'The order this ships against, by id, e.g. WO-2026-0001, INV-2026-0007 or PO-4471'}, 'duplicate_ok': {'type': 'boolean', 'description': 'Open it even though an OPEN list already exists on this reference. Default false'}, 'reference_kind': {'enum': ['quote', 'work_order', 'invoice', 'order'], 'type': 'string', 'description': 'What the reference is. Inferred from the id when omitted: WO- work order, INV- invoice, Q- quote, otherwise a plain order'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['packing_list', 'confirm'], 'properties': {'confirm': {'type': 'boolean', 'const': True, 'description': 'Must be true. There is no undo and nothing is copied anywhere first'}, 'packing_list': {'type': 'string', 'maxLength': 200, 'description': 'The packing list id, e.g. PL-2026-0001, or the order reference when only one list carries it'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'status': {'enum': ['draft', 'packed', 'shipped', 'cancelled'], 'type': 'string', 'description': 'Only lists in this status'}, 'divisor': {'type': 'integer', 'description': 'Volumetric divisor in cm3 per kg: 5000 courier air (default), 6000 IATA air, 4000 some road tariffs'}, 'consignee': {'type': 'string', 'maxLength': 200, 'description': 'Only lists whose consignee contains this text'}, 'open_only': {'type': 'boolean', 'description': 'Only draft and packed lists, the ones that count against the free tier. Default false'}, 'reference': {'type': 'string', 'maxLength': 64, 'description': 'Only lists against this order reference, matched case-insensitively'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['packing_list'], 'properties': {'divisor': {'type': 'integer', 'description': 'Volumetric divisor in cm3 per kg: 5000 courier air (default), 6000 IATA air, 4000 some road tariffs'}, 'packing_list': {'type': 'string', 'maxLength': 200, 'description': 'The packing list id, e.g. PL-2026-0001, or the order reference when only one list carries it'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['packing_list', 'status'], 'properties': {'date': {'type': 'string', 'maxLength': 10, 'description': 'The day the step happened, YYYY-MM-DD. Default today'}, 'note': {'type': 'string', 'maxLength': 2000}, 'force': {'type': 'boolean', 'description': 'Ship even though lines are short, over-packed or not on the order. Default false, and the reasons come back either way'}, 'status': {'enum': ['draft', 'packed', 'shipped', 'cancelled'], 'type': 'string', 'description': 'The status to move to. draft to packed to shipped, or cancelled from either open status'}, 'carrier': {'type': 'string', 'maxLength': 200, 'description': 'Who is carrying it, recorded when moving to shipped'}, 'tracking': {'type': 'string', 'maxLength': 200, 'description': "The carrier's consignment or tracking number, recorded when moving to shipped"}, 'packing_list': {'type': 'string', 'maxLength': 200, 'description': 'The packing list id, e.g. PL-2026-0001, or the order reference when only one list carries it'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['packing_list'], 'properties': {'packing_list': {'type': 'string', 'maxLength': 200, 'description': 'The packing list id, e.g. PL-2026-0001, or the order reference when only one list carries it'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['packing_list'], 'properties': {'divisor': {'type': 'integer', 'description': 'Volumetric divisor in cm3 per kg: 5000 courier air (default), 6000 IATA air, 4000 some road tariffs'}, 'out_path': {'type': 'string', 'maxLength': 1000, 'description': 'Name for the downloaded .txt file, e.g. order-4471-slip. Pro only. Omit to get the slip back as text, which every tier can do; the file comes back as a download link valid for one hour'}, 'overwrite': {'type': 'boolean', 'description': 'Replace out_path if a file is already there. Default false, and an existing file is refused with nothing written'}, 'packing_list': {'type': 'string', 'maxLength': 200, 'description': 'The packing list id, e.g. PL-2026-0001, or the order reference when only one list carries it'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['packing_list', 'carton', 'description', 'quantity'], 'properties': {'sku': {'type': 'string', 'maxLength': 64, 'description': 'Stock code, upper-cased and stripped of spaces. Lines with a SKU are matched on it, lines without on their description'}, 'note': {'type': 'string', 'maxLength': 2000}, 'carton': {'type': 'string', 'maxLength': 16, 'description': 'The carton id, e.g. C01, or its exact label'}, 'quantity': {'type': 'integer', 'maximum': 1000000, 'minimum': 1, 'description': 'How many units go into THIS carton. Split across cartons with one call each'}, 'unit_grams': {'type': 'integer', 'maximum': 100000000, 'minimum': 0, 'description': 'Weight of ONE unit in whole grams. Omit when not weighed; the carton is then a lower bound'}, 'description': {'type': 'string', 'maxLength': 2000, 'description': 'The goods going in, e.g. Oak shelf 900mm'}, 'packing_list': {'type': 'string', 'maxLength': 200, 'description': 'The packing list id, e.g. PL-2026-0001, or the order reference when only one list carries it'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['packing_list', 'line'], 'properties': {'line': {'type': 'string', 'maxLength': 16, 'description': 'The packed line id, e.g. L03, as shown by packing_list_show or carton_report'}, 'packing_list': {'type': 'string', 'maxLength': 200, 'description': 'The packing list id, e.g. PL-2026-0001, or the order reference when only one list carries it'}}, 'additionalProperties': False}