api/v1/swagger/definitions/basket.json

   1 {
   2     "type": "object",
   3     "properties": {
   4         "basket_id": {
   5             "type": "integer",
   6             "description": "Internal identifier for the basket"
   7         },
   8         "name": {
   9             "type": "string",
  10             "description": "Basket name"
  11         },
  12         "internal_note": {
  13             "type": [
  14                 "string",
  15                 "null"
  16             ],
  17             "description": "Internal note"
  18         },
  19         "vendor_note": {
  20             "type": [
  21                 "string",
  22                 "null"
  23             ],
  24             "description": "Vendor note"
  25         },
  26         "contract_id": {
  27             "type": "integer",
  28             "description": "Internal identifier of the linked contract"
  29         },
  30         "creation_date": {
  31             "type": [
  32                 "string",
  33                 "null"
  34             ],
  35             "format": "date",
  36             "description": "The date the basket was created"
  37         },
  38         "close_date": {
  39             "type": [
  40                 "string",
  41                 "null"
  42             ],
  43             "format": "date",
  44             "description": "The date the basket was closed"
  45         },
  46         "vendor_id": {
  47             "type": "integer",
  48             "description": "Internal identifier for the vendor"
  49         },
  50         "authorised_by": {
  51             "type": [
  52                 "integer",
  53                 "null"
  54             ],
  55             "description": "Internal patron identifier of the basket creator"
  56         },
  57         "basket_group_id": {
  58             "type": [
  59                 "integer",
  60                 "null"
  61             ],
  62             "description": "links this basket to its group (aqbasketgroups.id)"
  63         },
  64         "delivery_library": {
  65             "type": [
  66                 "string",
  67                 "null"
  68             ],
  69             "description": "basket delivery place"
  70         },
  71         "billing_library": {
  72             "type": [
  73                 "string",
  74                 "null"
  75             ],
  76             "description": "basket billing place"
  77         },
  78         "library_id": {
  79             "type": [
  80                 "integer",
  81                 "null"
  82             ],
  83             "description": "Library the basket belongs to"
  84         },
  85         "standing": {
  86             "type": "boolean",
  87             "description": "If the orders in this basket are standing"
  88         },
  89         "create_items": {
  90             "type": "string",
  91             "enum": [
  92                 "ordering",
  93                 "receiving",
  94                 "cataloguing"
  95             ],
  96             "description": "When items should be created for orders in this basket (Options: 'ordering', 'receiving', 'cataloguing'. Null means system wide config)"
  97         }
  98     }
  99 }