@simpleapps-com/augur-api 2026.10.10 → 2026.10.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -316,6 +316,12 @@ interface EndpointConfig {
316
316
  method: HTTPMethod;
317
317
  /** Endpoint path (will be prefixed with baseUrl) */
318
318
  path: string;
319
+ /**
320
+ * Path param → anchored regex its value MUST match (the endpoint's registry
321
+ * `pathPatterns`, shared/REGISTRY.md). A param without one only has to be
322
+ * non-empty and well-formed.
323
+ */
324
+ pathPatterns?: Readonly<Record<string, string>>;
319
325
  /** Valibot schema for validating request parameters */
320
326
  paramsSchema?: v.GenericSchema;
321
327
  /** Valibot schema for validating response data */
@@ -457,15 +463,19 @@ declare abstract class BaseServiceClient {
457
463
  */
458
464
  private createValidationError;
459
465
  /**
460
- * Build endpoint path with optional path parameter substitution
466
+ * Build endpoint path with optional path parameter substitution.
467
+ * Each value is validated against its placeholder's pattern, then
468
+ * percent-encoded per segment (`encodePathSegment`).
461
469
  *
462
470
  * @param pathTemplate Path template with {param} placeholders
463
471
  * @param pathParams Object containing parameter values
472
+ * @param pathPatterns Placeholder name → anchored regex its value MUST match
464
473
  * @returns Processed endpoint path
465
474
  *
466
475
  * @example
467
476
  * ```typescript
468
477
  * buildEndpointPath('/users/{id}', { id: '123' }) // returns '/users/123'
478
+ * buildEndpointPath('/bins/{bin}', { bin: 'D/S' }) // returns '/bins/D%2FS'
469
479
  * buildEndpointPath('/health-check') // returns '/health-check'
470
480
  * ```
471
481
  */
@@ -496,6 +506,8 @@ interface EndpointEntry {
496
506
  readonly path: string;
497
507
  /** Path params in URL order */
498
508
  readonly pathParams: readonly string[];
509
+ /** Path param → anchored regex its value MUST match; params without one are absent */
510
+ readonly pathPatterns: Readonly<Record<string, string>>;
499
511
  readonly queryParams: readonly string[];
500
512
  /** Alternative action names; an alias id is `service.chain.alias` */
501
513
  readonly aliases: readonly string[];
@@ -741,7 +753,7 @@ interface ActionLogsListItem {
741
753
  id: number;
742
754
  /** Joomla language key of the log message (max 255 chars) */
743
755
  messageLanguageKey: string;
744
- /** Log message data (JSON) (max 2147483647 chars) */
756
+ /** Log message data (JSON) */
745
757
  message: string;
746
758
  /** When the action happened (mysql-datetime, e.g. 2025-07-30 15:50:49) */
747
759
  logDate: string;
@@ -794,7 +806,7 @@ interface CategoriesListItem$1 {
794
806
  alias: string;
795
807
  /** Admin note (max 255 chars) */
796
808
  note: string;
797
- /** Category description (HTML) (max 16777215 chars) */
809
+ /** Category description (HTML) */
798
810
  description: string | null;
799
811
  /** Publish state (1 = published, 0 = unpublished, -2 = trashed) */
800
812
  published: number;
@@ -804,7 +816,7 @@ interface CategoriesListItem$1 {
804
816
  checkedOutTime: string;
805
817
  /** Access level ID */
806
818
  access: number;
807
- /** Joomla params JSON (max 16777215 chars) */
819
+ /** Joomla params JSON */
808
820
  params: string | null;
809
821
  /** Meta description (max 1024 chars) */
810
822
  metadesc: string;
@@ -956,7 +968,7 @@ interface MenuListItem {
956
968
  img: string;
957
969
  /** Template style; 0 for the default */
958
970
  templateStyleId: number;
959
- /** Joomla params JSON (max 16777215 chars) */
971
+ /** Joomla params JSON */
960
972
  params: string;
961
973
  /** Nested-set left value */
962
974
  lft: number;
@@ -1023,7 +1035,7 @@ interface ModulesListItem {
1023
1035
  title: string;
1024
1036
  /** Admin note (max 255 chars) */
1025
1037
  note: string;
1026
- /** Custom module content (HTML) (max 2147483647 chars) */
1038
+ /** Custom module content (HTML) */
1027
1039
  content: string | null;
1028
1040
  /** Sort position within the position */
1029
1041
  ordering: number;
@@ -1045,7 +1057,7 @@ interface ModulesListItem {
1045
1057
  access: number;
1046
1058
  /** 1 when the title is shown */
1047
1059
  showtitle: number;
1048
- /** Joomla params JSON (max 2147483647 chars) */
1060
+ /** Joomla params JSON */
1049
1061
  params: string;
1050
1062
  /** 0 = site, 1 = administrator */
1051
1063
  clientId: number;
@@ -1109,41 +1121,41 @@ interface UsersListItemGroupsItem {
1109
1121
  interface UsersListItemShipToItemAddress {
1110
1122
  /** Prophet 21 address ID */
1111
1123
  id: number;
1112
- /** Address name */
1124
+ /** Address name (max 50 chars) */
1113
1125
  name: string;
1114
- /** Mailing address line 1 */
1126
+ /** Mailing address line 1 (max 50 chars) */
1115
1127
  mailAddress1: string | null;
1116
- /** Mailing address line 2 */
1128
+ /** Mailing address line 2 (max 50 chars) */
1117
1129
  mailAddress2: string | null;
1118
- /** Mailing address line 3 */
1130
+ /** Mailing address line 3 (max 50 chars) */
1119
1131
  mailAddress3: string | null;
1120
- /** Mailing city */
1132
+ /** Mailing city (max 50 chars) */
1121
1133
  mailCity: string | null;
1122
- /** Mailing state or province */
1134
+ /** Mailing state or province (max 50 chars) */
1123
1135
  mailState: string | null;
1124
- /** Mailing postal code */
1136
+ /** Mailing postal code (max 10 chars) */
1125
1137
  mailPostalCode: string | null;
1126
- /** Mailing country */
1138
+ /** Mailing country (max 50 chars) */
1127
1139
  mailCountry: string | null;
1128
- /** Physical address line 1 */
1140
+ /** Physical address line 1 (max 50 chars) */
1129
1141
  physAddress1: string | null;
1130
- /** Physical address line 2 */
1142
+ /** Physical address line 2 (max 50 chars) */
1131
1143
  physAddress2: string | null;
1132
- /** Physical address line 3 */
1144
+ /** Physical address line 3 (max 50 chars) */
1133
1145
  physAddress3: string | null;
1134
- /** Physical city */
1146
+ /** Physical city (max 50 chars) */
1135
1147
  physCity: string | null;
1136
- /** Physical state or province */
1148
+ /** Physical state or province (max 50 chars) */
1137
1149
  physState: string | null;
1138
- /** Physical postal code */
1150
+ /** Physical postal code (max 10 chars) */
1139
1151
  physPostalCode: string | null;
1140
- /** Physical country */
1152
+ /** Physical country (max 50 chars) */
1141
1153
  physCountry: string | null;
1142
- /** Address class 5 */
1154
+ /** Address class 5 (max 8 chars) */
1143
1155
  class5Id: string | null;
1144
- /** Main phone number */
1156
+ /** Main phone number (max 20 chars) */
1145
1157
  centralPhoneNumber: string | null;
1146
- /** UPS code for the address */
1158
+ /** UPS code for the address (max 40 chars) */
1147
1159
  upsCode: string | null;
1148
1160
  [key: string]: unknown;
1149
1161
  }
@@ -1158,15 +1170,15 @@ interface UsersListItemShipToItem {
1158
1170
  shipToId: number;
1159
1171
  /** Prophet 21 customer the ship-to belongs to */
1160
1172
  customerId: number;
1161
- /** Prophet 21 company */
1173
+ /** Prophet 21 company (max 8 chars) */
1162
1174
  companyId: string;
1163
- /** Default branch for the ship-to */
1175
+ /** Default branch for the ship-to (max 8 chars) */
1164
1176
  defaultBranch: string;
1165
1177
  /** Prophet 21 address ID of the default carrier */
1166
1178
  defaultCarrierId: number | null;
1167
1179
  /** Prophet 21 location the ship-to prefers to ship from */
1168
1180
  preferredLocationId: number | null;
1169
- /** Delivery instructions for the carrier */
1181
+ /** Delivery instructions for the carrier (max 255 chars) */
1170
1182
  deliveryInstructions: string | null;
1171
1183
  /** Shipping route assigned to the ship-to */
1172
1184
  shippingRouteUid: number | null;
@@ -1471,29 +1483,29 @@ interface UsersTrinityListDataProfile {
1471
1483
  interface UsersTrinityListDataP21RoleAddress {
1472
1484
  /** Prophet 21 address ID */
1473
1485
  id: number;
1474
- /** Physical address line 1 */
1486
+ /** Physical address line 1 (max 50 chars) */
1475
1487
  physAddress1: string | null;
1476
- /** Physical address line 2 */
1488
+ /** Physical address line 2 (max 50 chars) */
1477
1489
  physAddress2: string | null;
1478
- /** Physical city */
1490
+ /** Physical city (max 50 chars) */
1479
1491
  physCity: string | null;
1480
- /** Physical state or province */
1492
+ /** Physical state or province (max 50 chars) */
1481
1493
  physState: string | null;
1482
- /** Physical postal code */
1494
+ /** Physical postal code (max 10 chars) */
1483
1495
  physPostalCode: string | null;
1484
- /** Physical country */
1496
+ /** Physical country (max 50 chars) */
1485
1497
  physCountry: string | null;
1486
- /** Mailing address line 1 */
1498
+ /** Mailing address line 1 (max 50 chars) */
1487
1499
  mailAddress1: string | null;
1488
- /** Mailing address line 2 */
1500
+ /** Mailing address line 2 (max 50 chars) */
1489
1501
  mailAddress2: string | null;
1490
- /** Mailing city */
1502
+ /** Mailing city (max 50 chars) */
1491
1503
  mailCity: string | null;
1492
- /** Mailing state or province */
1504
+ /** Mailing state or province (max 50 chars) */
1493
1505
  mailState: string | null;
1494
- /** Mailing postal code */
1506
+ /** Mailing postal code (max 10 chars) */
1495
1507
  mailPostalCode: string | null;
1496
- /** Mailing country */
1508
+ /** Mailing country (max 50 chars) */
1497
1509
  mailCountry: string | null;
1498
1510
  [key: string]: unknown;
1499
1511
  }
@@ -2248,15 +2260,15 @@ interface CartHdrAlsoBoughtListItemInventorySupplierItem {
2248
2260
  invMastUid: number;
2249
2261
  /** Supplier ID */
2250
2262
  supplierId: number;
2251
- /** Supplier UPC code; empty when none */
2263
+ /** Supplier UPC code; empty when none (max 14 chars) */
2252
2264
  upcCode: string;
2253
- /** UPC check digit; empty when none */
2254
- checkDigit: string;
2265
+ /** UPC check digit (P21 decimal(1,0)); null when none */
2266
+ checkDigit: number | null;
2255
2267
  /** upcCode followed by checkDigit */
2256
2268
  upc: string;
2257
- /** Supplier part number */
2269
+ /** Supplier part number (max 40 chars) */
2258
2270
  supplierPartNo: string | null;
2259
- /** Y when this is the item's primary supplier */
2271
+ /** Y when this is the item's primary supplier (max 1 chars) */
2260
2272
  primarySupplierFlag: string | null;
2261
2273
  /** Supplier list price */
2262
2274
  listPrice: number | null;
@@ -2269,7 +2281,7 @@ interface CartHdrAlsoBoughtListItemInventorySupplierItem {
2269
2281
  * Field `itemUom` of CartHdrAlsoBoughtListItem
2270
2282
  */
2271
2283
  interface CartHdrAlsoBoughtListItemItemUomItem {
2272
- /** Unit of measure code */
2284
+ /** Unit of measure code (max 8 chars) */
2273
2285
  unitOfMeasure: string;
2274
2286
  /** Base units per one of this unit */
2275
2287
  unitSize: number;
@@ -2412,25 +2424,27 @@ interface CartHdrAlsoBoughtListItemAttributesItem {
2412
2424
  interface CartHdrAlsoBoughtListItemStockStockDataItem {
2413
2425
  /** Location ID */
2414
2426
  locationId: number;
2415
- /** Company the location belongs to */
2427
+ /** Company the location belongs to (max 8 chars) */
2416
2428
  companyId: string;
2417
2429
  /** Quantity on hand, in base units */
2418
2430
  qtyOnHand: number;
2419
2431
  /** Quantity allocated, in base units */
2420
2432
  qtyAllocated: number;
2421
- /** Y when the item is stocked at the location */
2433
+ /** Y when the item is stocked at the location (max 1 chars) */
2422
2434
  stockable: string | null;
2423
- /** Y when the item is sold from the location */
2435
+ /** Y when the item is sold from the location (max 1 chars) */
2424
2436
  sellable: string | null;
2425
- /** Y when the item is discontinued at the location */
2437
+ /** Y when the item is discontinued at the location (max 1 chars) */
2426
2438
  discontinued: string;
2439
+ /** Y when the location record is deleted in P21 (inv_loc.delete_flag) (max 1 chars) */
2440
+ deleteFlag: string | null;
2427
2441
  /** qtyOnHand minus qtyAllocated */
2428
2442
  unallocated: number;
2429
2443
  /** Date (Y-m-d) the next purchase order is due in */
2430
2444
  nextDueInPoDate: string | null;
2431
2445
  /** Quantity backordered */
2432
2446
  qtyBackordered: number | null;
2433
- /** Primary bin */
2447
+ /** Primary bin (max 10 chars) */
2434
2448
  primaryBin: string | null;
2435
2449
  /** Quantity frozen */
2436
2450
  qtyFrozen: number;
@@ -2442,13 +2456,13 @@ interface CartHdrAlsoBoughtListItemStockStockDataItem {
2442
2456
  qtyAvailable: number;
2443
2457
  /** Order quantity */
2444
2458
  orderQuantity: number | null;
2445
- /** Product group at the location */
2459
+ /** Product group at the location (max 8 chars) */
2446
2460
  productGroupId: string | null;
2447
2461
  /** Item base unit */
2448
2462
  baseUnit: string;
2449
2463
  /** Base unit size (1 when unset) */
2450
2464
  baseUnitSize: number;
2451
- /** Item default selling unit */
2465
+ /** Item default selling unit (max 8 chars) */
2452
2466
  defaultSellingUnit: string | null;
2453
2467
  /** Default selling unit size */
2454
2468
  defaultSellingUnitSize: number;
@@ -2590,55 +2604,55 @@ interface CartHdrAlsoBoughtListItemFullSizedSamplesOption1 {
2590
2604
  interface CartHdrAlsoBoughtListItem {
2591
2605
  /** Item (inv_mast) ID */
2592
2606
  invMastUid: number;
2593
- /** Item ID */
2607
+ /** Item ID (max 40 chars) */
2594
2608
  itemId: string;
2595
- /** Item description */
2609
+ /** Item description (max 40 chars) */
2596
2610
  itemDesc: string | null;
2597
2611
  /** First web-displayed category description for the item */
2598
2612
  displayDesc: string | null;
2599
- /** Extended description */
2613
+ /** Extended description (max 255 chars) */
2600
2614
  extendedDesc: string | null;
2601
- /** Short code */
2615
+ /** Short code (max 30 chars) */
2602
2616
  shortCode: string | null;
2603
- /** Default selling unit */
2617
+ /** Default selling unit (max 8 chars) */
2604
2618
  defaultSellingUnit: string | null;
2605
- /** Default purchasing unit */
2619
+ /** Default purchasing unit (max 8 chars) */
2606
2620
  defaultPurchasingUnit: string | null;
2607
- /** Y when the item is deleted */
2621
+ /** Y when the item is deleted (max 1 chars) */
2608
2622
  deleteFlag: string;
2609
2623
  /** Online code (704 = online) */
2610
2624
  onlineCd: number;
2611
2625
  /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
2612
2626
  statusCd: number;
2613
- /** Base unit */
2627
+ /** Base unit (max 8 chars) */
2614
2628
  baseUnit: string;
2615
2629
  /** Vendor stock quantity */
2616
2630
  vndrStock: number | null;
2617
- /** Item class 1 */
2631
+ /** Item class 1 (max 8 chars) */
2618
2632
  classId1: string | null;
2619
- /** Item class 2 */
2633
+ /** Item class 2 (max 8 chars) */
2620
2634
  classId2: string | null;
2621
- /** Item class 3 */
2635
+ /** Item class 3 (max 8 chars) */
2622
2636
  classId3: string | null;
2623
- /** Item class 4 */
2637
+ /** Item class 4 (max 8 chars) */
2624
2638
  classId4: string | null;
2625
- /** Item class 5 */
2639
+ /** Item class 5 (max 8 chars) */
2626
2640
  classId5: string | null;
2627
- /** Y when the item is serialized */
2641
+ /** Y when the item is serialized (max 1 chars) */
2628
2642
  serialized: string;
2629
- /** Y when the item is lot-tracked */
2643
+ /** Y when the item is lot-tracked (max 1 chars) */
2630
2644
  trackLots: string;
2631
2645
  /** Tracking pattern derived from serialized and trackLots */
2632
2646
  trackingPattern: string;
2633
- /** Default product group */
2647
+ /** Default product group (max 8 chars) */
2634
2648
  defaultProductGroup: string | null;
2635
- /** Default sales discount group */
2649
+ /** Default sales discount group (max 8 chars) */
2636
2650
  defaultSalesDiscountGroup: string | null;
2637
- /** Default purchase discount group */
2651
+ /** Default purchase discount group (max 8 chars) */
2638
2652
  defaultPurchaseDiscGroup: string | null;
2639
- /** UPC or EAN code type */
2653
+ /** UPC or EAN code type (max 3 chars) */
2640
2654
  upcOrEan: string | null;
2641
- /** UPC or EAN code */
2655
+ /** UPC or EAN code (max 15 chars) */
2642
2656
  upcOrEanId: string | null;
2643
2657
  /** Weight */
2644
2658
  weight: number | null;
@@ -2648,11 +2662,11 @@ interface CartHdrAlsoBoughtListItem {
2648
2662
  width: number | null;
2649
2663
  /** Height */
2650
2664
  height: number | null;
2651
- /** Parker product code */
2665
+ /** Parker product code (max 255 chars) */
2652
2666
  parkerProductCd: string | null;
2653
- /** Brand name */
2667
+ /** Brand name (max 255 chars) */
2654
2668
  brandName: string | null;
2655
- /** Manufacturer name */
2669
+ /** Manufacturer name (max 255 chars) */
2656
2670
  manufacturerName: string | null;
2657
2671
  /** The item's suppliers (not deleted) */
2658
2672
  inventorySupplier: CartHdrAlsoBoughtListItemInventorySupplierItem[];
@@ -2676,8 +2690,8 @@ interface CartHdrAlsoBoughtListItem {
2676
2690
  stock: CartHdrAlsoBoughtListItemStock;
2677
2691
  /** Category display description per item category ID */
2678
2692
  categoryDisplayDescriptions: Record<string, string>;
2679
- /** Non-empty user-defined field values, keyed by field name ([] when empty) */
2680
- userDefined: Record<string, unknown> | [];
2693
+ /** Non-empty user-defined field values, keyed by field name; {} when the item has none */
2694
+ userDefined: Record<string, unknown>;
2681
2695
  /** Prophet 21 item text blocks (empty unless the site has a p21_pim config) */
2682
2696
  invMastText: CartHdrAlsoBoughtListItemInvMastTextItem[];
2683
2697
  /** Descriptions in other languages */
@@ -2737,11 +2751,11 @@ interface CartLineGetItem {
2737
2751
  invMastUid: number;
2738
2752
  /** Quantity in unitOfMeasure */
2739
2753
  quantity: number | null;
2740
- /** Unit of measure */
2754
+ /** Unit of measure (max 8 chars) */
2741
2755
  unitOfMeasure: string | null;
2742
- /** Line note */
2756
+ /** Line note (max 255 chars) */
2743
2757
  lineNote: string | null;
2744
- /** Caller key that identifies the line, when the site enables cart line keys */
2758
+ /** Caller key that identifies the line, when the site enables cart line keys (max 255 chars) */
2745
2759
  key: string | null;
2746
2760
  /** Unit price stored on the line */
2747
2761
  unitPrice: number | null;
@@ -2781,17 +2795,17 @@ interface CartLineAddCreateBodyItem {
2781
2795
  invMastUid: number | null;
2782
2796
  /** Quantity in unitOfMeasure */
2783
2797
  quantity: number | null;
2784
- /** Unit of measure; upper-cased before it is stored */
2798
+ /** Unit of measure; upper-cased before it is stored (max 8 chars) */
2785
2799
  unitOfMeasure: string | null;
2786
2800
  /** Line number to write; absent or 0 lets the cart pick the line (by item, or by key on add) */
2787
2801
  lineNo?: number | null;
2788
- /** Line note, at most 255 characters kept */
2802
+ /** Line note, at most 255 characters kept (max 255 chars) */
2789
2803
  lineNote?: string | null;
2790
2804
  /** Unit price to store on the line; absent stores none */
2791
2805
  unitPrice?: number | null;
2792
2806
  /**
2793
2807
  * Caller key that identifies the line on add when the site enables cart line keys; ignored by
2794
- * update
2808
+ * update (max 255 chars)
2795
2809
  */
2796
2810
  key?: string | null;
2797
2811
  [key: string]: unknown;
@@ -2927,11 +2941,11 @@ interface CheckoutGetData {
2927
2941
  dateCreated: string;
2928
2942
  /** Date the record was last modified (mysql-datetime, e.g. 2025-07-30 15:50:49) */
2929
2943
  dateLastModified: string;
2930
- /** Checkout properties as a JSON string (max 16777215 chars) */
2944
+ /** Checkout properties as a JSON string */
2931
2945
  properties: string | null;
2932
2946
  /** Checkout processor name; not set by the commerce service today (max 255 chars) */
2933
2947
  checkoutProcessor: string | null;
2934
- /** Storefront checkout payload as a JSON string, stored verbatim (max 16777215 chars) */
2948
+ /** Storefront checkout payload as a JSON string, stored verbatim */
2935
2949
  jsonData: string | null;
2936
2950
  /** Source system name for a checkout brought in from another service (legacy) (max 255 chars) */
2937
2951
  sourceName: string | null;
@@ -4137,15 +4151,17 @@ type WebPricingCreateData = WebPricingListItem;
4137
4151
  * Request body of: api.pricing.webPricing.create(data)
4138
4152
  */
4139
4153
  interface WebPricingCreateBody {
4140
- /** Rule name; required and MUST NOT be empty */
4154
+ /** Rule name; required and MUST NOT be empty (max 255 chars) */
4141
4155
  name: string | null;
4142
4156
  /** Percentage taken off the engine unit price; required, above 0 and at most 100 */
4143
4157
  discountPct: number | null;
4144
- /** Optional free-text note about the rule */
4158
+ /** Optional free-text note about the rule (max 255 chars) */
4145
4159
  description?: string | null;
4146
4160
  /** Evaluation order, ascending; the first matching rule wins (Default: 1) */
4147
4161
  sequenceNo?: number | null;
4148
- /** Which customers the rule applies to: NONE, ALL, ONLY or EXCEPT (Default: NONE) */
4162
+ /**
4163
+ * Which customers the rule applies to: NONE, ALL, ONLY or EXCEPT (Default: NONE) (max 255 chars)
4164
+ */
4149
4165
  customerMode?: string | null;
4150
4166
  /** Minimum cart quantity; 0 or less means no lower bound (Default: -1) */
4151
4167
  minQty?: number | null;
@@ -4183,13 +4199,13 @@ type WebPricingUpdateData = WebPricingListItem;
4183
4199
  * Request body of: api.pricing.webPricing.update(webPricingUid, data)
4184
4200
  */
4185
4201
  interface WebPricingUpdateBody {
4186
- /** Rule name; MUST NOT be empty when sent */
4202
+ /** Rule name; MUST NOT be empty when sent (max 255 chars) */
4187
4203
  name?: string | null;
4188
- /** Free-text note about the rule; sending null clears it */
4204
+ /** Free-text note about the rule; sending null clears it (max 255 chars) */
4189
4205
  description?: string | null;
4190
4206
  /** Evaluation order, ascending; the first matching rule wins */
4191
4207
  sequenceNo?: number | null;
4192
- /** Which customers the rule applies to: NONE, ALL, ONLY or EXCEPT */
4208
+ /** Which customers the rule applies to: NONE, ALL, ONLY or EXCEPT (max 255 chars) */
4193
4209
  customerMode?: string | null;
4194
4210
  /** Minimum cart quantity; 0 or less means no lower bound */
4195
4211
  minQty?: number | null;
@@ -5003,13 +5019,16 @@ type DistributorsCreateData = DistributorsListItem;
5003
5019
  interface DistributorsCreateBody {
5004
5020
  /** Prophet 21 customer the distributor belongs to; without it nothing is created */
5005
5021
  customerId: number | null;
5006
- /** Distributor name; distributors_id is derived from it. Without it nothing is created */
5022
+ /**
5023
+ * Distributor name; distributors_id is derived from it. Without it nothing is created (max 255
5024
+ * chars)
5025
+ */
5007
5026
  distributorsName: string | null;
5008
- /** Distributor description */
5027
+ /** Distributor description (max 255 chars) */
5009
5028
  distributorsDesc?: string | null;
5010
- /** Distributor contact email */
5029
+ /** Distributor contact email (max 255 chars) */
5011
5030
  distributorsEmail?: string | null;
5012
- /** Customer's account number with the distributor */
5031
+ /** Customer's account number with the distributor (max 255 chars) */
5013
5032
  distributorsAccount?: string | null;
5014
5033
  [key: string]: unknown;
5015
5034
  }
@@ -5036,13 +5055,13 @@ type DistributorsUpdateData = boolean;
5036
5055
  interface DistributorsUpdateBody {
5037
5056
  /** Prophet 21 customer the distributor belongs to */
5038
5057
  customerId?: number | null;
5039
- /** Distributor name; distributors_id is re-derived from it */
5058
+ /** Distributor name; distributors_id is re-derived from it (max 255 chars) */
5040
5059
  distributorsName?: string | null;
5041
- /** Distributor description */
5060
+ /** Distributor description (max 255 chars) */
5042
5061
  distributorsDesc?: string | null;
5043
- /** Distributor contact email */
5062
+ /** Distributor contact email (max 255 chars) */
5044
5063
  distributorsEmail?: string | null;
5045
- /** Customer's account number with the distributor */
5064
+ /** Customer's account number with the distributor (max 255 chars) */
5046
5065
  distributorsAccount?: string | null;
5047
5066
  [key: string]: unknown;
5048
5067
  }
@@ -5160,9 +5179,9 @@ interface DistributorsProductsCreateBody {
5160
5179
  interface InvProfileHdrListItem {
5161
5180
  /** Inventory profile ID */
5162
5181
  invProfileHdrUid: number;
5163
- /** Profile key derived from the description */
5182
+ /** Profile key derived from the description (max 255 chars) */
5164
5183
  invProfileHdrId: string;
5165
- /** Profile description */
5184
+ /** Profile description (max 255 chars) */
5166
5185
  invProfileHdrDesc: string;
5167
5186
  /** Prophet 21 customer the profile belongs to */
5168
5187
  customerId: number;
@@ -5211,7 +5230,10 @@ interface InvProfileHdrCreateData {
5211
5230
  * Request body of: api.vmi.invProfileHdr.create(data)
5212
5231
  */
5213
5232
  interface InvProfileHdrCreateBody {
5214
- /** Profile description; inv_profile_hdr_id is derived from it. Without it nothing is created */
5233
+ /**
5234
+ * Profile description; inv_profile_hdr_id is derived from it. Without it nothing is created (max
5235
+ * 255 chars)
5236
+ */
5215
5237
  invProfileHdrDesc: string | null;
5216
5238
  /** Prophet 21 customer the profile belongs to; without it nothing is created */
5217
5239
  customerId: number | null;
@@ -5360,7 +5382,7 @@ interface InvProfileHdrInvProfileLineCreateBodyItem {
5360
5382
  * skipped
5361
5383
  */
5362
5384
  invMastUid: number | null;
5363
- /** Item source: products or prophet21; without it the line is skipped */
5385
+ /** Item source: products or prophet21; without it the line is skipped (max 255 chars) */
5364
5386
  invProfileLineType: string | null;
5365
5387
  /** Minimum quantity to keep on hand; defaults to 1 */
5366
5388
  invProfileHdrMinQty?: number | null;
@@ -5404,7 +5426,7 @@ interface InvProfileHdrInvProfileLineUpdateBody {
5404
5426
  invProfileHdrUid?: number | null;
5405
5427
  /** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
5406
5428
  invMastUid?: number | null;
5407
- /** Item source: products or prophet21 */
5429
+ /** Item source: products or prophet21 (max 255 chars) */
5408
5430
  invProfileLineType?: string | null;
5409
5431
  /** Minimum quantity to keep on hand */
5410
5432
  invProfileHdrMinQty?: number | null;
@@ -5548,7 +5570,7 @@ interface RestockHdrListItem {
5548
5570
  statusCd: number;
5549
5571
  /** Process code (704 = Active, 1185 = Import Complete) */
5550
5572
  processCd: number;
5551
- /** The create request body, JSON-encoded (max 2147483647 chars) */
5573
+ /** The create request body, JSON-encoded */
5552
5574
  jsonData: string | null;
5553
5575
  /** Processing state of the restock order (max 30 chars) */
5554
5576
  processState: string;
@@ -5581,7 +5603,7 @@ interface RestockHdrCreateDataRestockItemsItem {
5581
5603
  lineNo: number;
5582
5604
  /** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
5583
5605
  invMastUid: number;
5584
- /** Item source: products or prophet21 */
5606
+ /** Item source: products or prophet21 (max 255 chars) */
5585
5607
  invProfileLineType: string;
5586
5608
  /** Quantity to restock */
5587
5609
  unitQty: number;
@@ -5627,17 +5649,17 @@ interface RestockHdrCreateData {
5627
5649
  processCd: number;
5628
5650
  /** The create request body, JSON-encoded */
5629
5651
  jsonData: string | null;
5630
- /** Processing state */
5652
+ /** Processing state (max 30 chars) */
5631
5653
  processState: string;
5632
- /** Customer purchase order number */
5654
+ /** Customer purchase order number (max 50 chars) */
5633
5655
  poNo: string | null;
5634
5656
  /** joomla.users.id of the requester */
5635
5657
  usersId: number;
5636
5658
  /** Prophet 21 customer placing the restock */
5637
5659
  customerId: number;
5638
- /** Prophet 21 contact placing the restock */
5660
+ /** Prophet 21 contact placing the restock (max 16 chars) */
5639
5661
  contactId: string | null;
5640
- /** Delivery instructions for the order */
5662
+ /** Delivery instructions for the order (max 255 chars) */
5641
5663
  deliveryInstructions: string | null;
5642
5664
  /** Items on the request */
5643
5665
  restockItems: RestockHdrCreateDataRestockItemsItem[];
@@ -5652,7 +5674,7 @@ interface RestockHdrCreateData {
5652
5674
  interface RestockHdrCreateBodyRestockItemsItem {
5653
5675
  /** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
5654
5676
  invMastUid: number | null;
5655
- /** Item source: products or prophet21 */
5677
+ /** Item source: products or prophet21 (max 255 chars) */
5656
5678
  invProfileLineType: string | null;
5657
5679
  /** Quantity to restock */
5658
5680
  unitQty: number | null;
@@ -5673,13 +5695,13 @@ interface RestockHdrCreateBody {
5673
5695
  usersId: number | null;
5674
5696
  /** Prophet 21 customer placing the restock */
5675
5697
  customerId: number | null;
5676
- /** Prophet 21 contact placing the restock */
5698
+ /** Prophet 21 contact placing the restock (max 16 chars) */
5677
5699
  contactId: string | null;
5678
5700
  /** Items to restock; an empty list creates nothing */
5679
5701
  restockItems: RestockHdrCreateBodyRestockItemsItem[];
5680
- /** Customer purchase order number */
5702
+ /** Customer purchase order number (max 50 chars) */
5681
5703
  poNo?: string | null;
5682
- /** Delivery instructions for the order */
5704
+ /** Delivery instructions for the order (max 255 chars) */
5683
5705
  deliveryInstructions?: string | null;
5684
5706
  [key: string]: unknown;
5685
5707
  }
@@ -5768,11 +5790,11 @@ type SectionsCreateData = SectionsListItem;
5768
5790
  * Request body of: api.vmi.sections.create(data)
5769
5791
  */
5770
5792
  interface SectionsCreateBody {
5771
- /** Section name; sections_id is derived from it. Without it nothing is created */
5793
+ /** Section name; sections_id is derived from it. Without it nothing is created (max 255 chars) */
5772
5794
  sectionsName: string | null;
5773
5795
  /** Prophet 21 customer the section belongs to; without it nothing is created */
5774
5796
  customerId: number | null;
5775
- /** Section description; defaults to the section name */
5797
+ /** Section description; defaults to the section name (max 255 chars) */
5776
5798
  sectionsDesc?: string | null;
5777
5799
  [key: string]: unknown;
5778
5800
  }
@@ -5835,11 +5857,11 @@ type SectionsEnableUpdateBody = DistributorsEnableUpdateBody;
5835
5857
  interface WarehouseListItem {
5836
5858
  /** Warehouse ID */
5837
5859
  warehouseUid: number;
5838
- /** Warehouse key derived from the name */
5860
+ /** Warehouse key derived from the name (max 255 chars) */
5839
5861
  warehouseId: string;
5840
- /** Warehouse name */
5862
+ /** Warehouse name (max 255 chars) */
5841
5863
  warehouseName: string;
5842
- /** Warehouse description */
5864
+ /** Warehouse description (max 255 chars) */
5843
5865
  warehouseDesc: string;
5844
5866
  /** When the warehouse was created (Y-m-d H:i:s) */
5845
5867
  dateCreated: string;
@@ -5905,9 +5927,9 @@ interface WarehouseCreateData {
5905
5927
  interface WarehouseCreateBody {
5906
5928
  /** Prophet 21 customer the warehouse belongs to */
5907
5929
  customerId: number | null;
5908
- /** Warehouse name; warehouse_id is derived from it */
5930
+ /** Warehouse name; warehouse_id is derived from it (max 255 chars) */
5909
5931
  warehouseName: string | null;
5910
- /** Warehouse description */
5932
+ /** Warehouse description (max 255 chars) */
5911
5933
  warehouseDesc: string | null;
5912
5934
  /** Inventory profile stocked in the warehouse; defaults to 0 (none) */
5913
5935
  invProfileHdrUid?: number | null;
@@ -5934,9 +5956,9 @@ type WarehouseUpdateData = WarehouseCreateData;
5934
5956
  * Request body of: api.vmi.warehouse.update(warehouseUid, data)
5935
5957
  */
5936
5958
  interface WarehouseUpdateBody {
5937
- /** Warehouse name; warehouse_id is re-derived from it */
5959
+ /** Warehouse name; warehouse_id is re-derived from it (max 255 chars) */
5938
5960
  warehouseName?: string | null;
5939
- /** Warehouse description */
5961
+ /** Warehouse description (max 255 chars) */
5940
5962
  warehouseDesc?: string | null;
5941
5963
  /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
5942
5964
  statusCd?: number | null;
@@ -6009,7 +6031,7 @@ interface WarehouseAdjustCreateBody {
6009
6031
  interface WarehouseAvailabilityListDataSectionsValueItemsItem {
6010
6032
  /** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
6011
6033
  invMastUid: number;
6012
- /** Item source: products or prophet21 */
6034
+ /** Item source: products or prophet21 (max 255 chars) */
6013
6035
  invProfileLineType: string;
6014
6036
  /** Quantity on hand in the warehouse */
6015
6037
  qtyOnHand: number;
@@ -6204,7 +6226,7 @@ interface WarehouseUsageCreateDataUsageItemsItemWarranty {
6204
6226
  interface WarehouseUsageCreateDataUsageItemsItem {
6205
6227
  /** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
6206
6228
  invMastUid: number;
6207
- /** Item source: products or prophet21 */
6229
+ /** Item source: products or prophet21 (max 255 chars) */
6208
6230
  invProfileLineType: string;
6209
6231
  /** Line number, starting at 1 */
6210
6232
  lineNo: number;
@@ -6269,7 +6291,7 @@ interface WarehouseUsageCreateBodyUsageItemsItem {
6269
6291
  invMastUid: number | null;
6270
6292
  /** Quantity used; subtracted from on hand, never below zero */
6271
6293
  qtyUsed: number | null;
6272
- /** Item source: products or prophet21; defaults to prophet21 */
6294
+ /** Item source: products or prophet21; defaults to prophet21 (max 255 chars) */
6273
6295
  invProfileLineType?: string | null;
6274
6296
  /** Warranty claim for the item */
6275
6297
  warranty?: WarehouseUsageCreateBodyUsageItemsItemWarranty | null;
@@ -8060,7 +8082,7 @@ interface ItemsListItem {
8060
8082
  updateCd: number;
8061
8083
  /**
8062
8084
  * Search document JSON written to openSearch; over 500 bytes it is stored on EFS and this holds
8063
- * efs:{path} (max 4294967295 chars)
8085
+ * efs:{path}
8064
8086
  */
8065
8087
  doc: string | null;
8066
8088
  /** Marked items to have the index updated in openSearch */
@@ -8179,7 +8201,7 @@ interface QueryStringRedirectListItem {
8179
8201
  statusCd: number;
8180
8202
  /** Process code: 704 = Active, 705 = Inactive, 700 = Deleted, 1185 = Import Complete */
8181
8203
  processCd: number;
8182
- /** Cleaned search text that triggers the redirect (max 65535 chars) */
8204
+ /** Cleaned search text that triggers the redirect */
8183
8205
  queryString: string | null;
8184
8206
  [key: string]: unknown;
8185
8207
  }
@@ -9103,7 +9125,7 @@ interface InvLocListParams extends EdgeCacheParams {
9103
9125
  /** Limit number of results (Default: 10) */
9104
9126
  limit?: number;
9105
9127
  /** Location ID (inv_loc.location_id); returns only rows for that location */
9106
- locationId?: string;
9128
+ locationId?: number;
9107
9129
  /** Return only rows modified on or after this date (YYYY-MM-DD HH:MM:SS) */
9108
9130
  modifiedSince?: string;
9109
9131
  /** Starting offset results (Default: 0) */
@@ -10753,7 +10775,7 @@ interface CategoriesImagesListData {
10753
10775
  * Field `itemUom` of InvMastSimilarListItem
10754
10776
  */
10755
10777
  interface CategoriesItemsListDataItemsItemItemUomItem {
10756
- /** Unit of measure code */
10778
+ /** Unit of measure code (max 8 chars) */
10757
10779
  unitOfMeasure: string;
10758
10780
  /** Base units per one of this unit */
10759
10781
  unitSize: number;
@@ -10773,15 +10795,15 @@ interface CategoriesItemsListDataItemsItemInventorySupplierItem {
10773
10795
  invMastUid: number;
10774
10796
  /** Supplier ID */
10775
10797
  supplierId: number;
10776
- /** Supplier UPC code; empty when none */
10798
+ /** Supplier UPC code; empty when none (max 14 chars) */
10777
10799
  upcCode: string;
10778
- /** UPC check digit; empty when none */
10779
- checkDigit: string;
10800
+ /** UPC check digit (P21 decimal(1,0)); null when none */
10801
+ checkDigit: number | null;
10780
10802
  /** upcCode followed by checkDigit */
10781
10803
  upc: string;
10782
- /** Supplier part number */
10804
+ /** Supplier part number (max 40 chars) */
10783
10805
  supplierPartNo: string | null;
10784
- /** Y when this is the item's primary supplier */
10806
+ /** Y when this is the item's primary supplier (max 1 chars) */
10785
10807
  primarySupplierFlag: string | null;
10786
10808
  /** Supplier list price */
10787
10809
  listPrice: number | null;
@@ -11256,55 +11278,55 @@ interface InvMastListItemLanguagesItem {
11256
11278
  interface InvMastListItem {
11257
11279
  /** Item (inv_mast) ID */
11258
11280
  invMastUid: number;
11259
- /** Item ID */
11281
+ /** Item ID (max 40 chars) */
11260
11282
  itemId: string;
11261
- /** Item description */
11283
+ /** Item description (max 40 chars) */
11262
11284
  itemDesc: string | null;
11263
11285
  /** First web-displayed category description for the item */
11264
11286
  displayDesc: string | null;
11265
- /** Extended description */
11287
+ /** Extended description (max 255 chars) */
11266
11288
  extendedDesc: string | null;
11267
- /** Short code */
11289
+ /** Short code (max 30 chars) */
11268
11290
  shortCode: string | null;
11269
- /** Default selling unit */
11291
+ /** Default selling unit (max 8 chars) */
11270
11292
  defaultSellingUnit: string | null;
11271
- /** Default purchasing unit */
11293
+ /** Default purchasing unit (max 8 chars) */
11272
11294
  defaultPurchasingUnit: string | null;
11273
- /** Y when the item is deleted */
11295
+ /** Y when the item is deleted (max 1 chars) */
11274
11296
  deleteFlag: string;
11275
11297
  /** Online code (704 = online) */
11276
11298
  onlineCd: number;
11277
11299
  /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
11278
11300
  statusCd: number;
11279
- /** Base unit */
11301
+ /** Base unit (max 8 chars) */
11280
11302
  baseUnit: string;
11281
11303
  /** Vendor stock quantity */
11282
11304
  vndrStock: number | null;
11283
- /** Item class 1 */
11305
+ /** Item class 1 (max 8 chars) */
11284
11306
  classId1: string | null;
11285
- /** Item class 2 */
11307
+ /** Item class 2 (max 8 chars) */
11286
11308
  classId2: string | null;
11287
- /** Item class 3 */
11309
+ /** Item class 3 (max 8 chars) */
11288
11310
  classId3: string | null;
11289
- /** Item class 4 */
11311
+ /** Item class 4 (max 8 chars) */
11290
11312
  classId4: string | null;
11291
- /** Item class 5 */
11313
+ /** Item class 5 (max 8 chars) */
11292
11314
  classId5: string | null;
11293
- /** Y when the item is serialized */
11315
+ /** Y when the item is serialized (max 1 chars) */
11294
11316
  serialized: string;
11295
- /** Y when the item is lot-tracked */
11317
+ /** Y when the item is lot-tracked (max 1 chars) */
11296
11318
  trackLots: string;
11297
11319
  /** Tracking pattern derived from serialized and trackLots */
11298
11320
  trackingPattern: string;
11299
- /** Default product group */
11321
+ /** Default product group (max 8 chars) */
11300
11322
  defaultProductGroup: string | null;
11301
- /** Default sales discount group */
11323
+ /** Default sales discount group (max 8 chars) */
11302
11324
  defaultSalesDiscountGroup: string | null;
11303
- /** Default purchase discount group */
11325
+ /** Default purchase discount group (max 8 chars) */
11304
11326
  defaultPurchaseDiscGroup: string | null;
11305
- /** UPC or EAN code type */
11327
+ /** UPC or EAN code type (max 3 chars) */
11306
11328
  upcOrEan: string | null;
11307
- /** UPC or EAN code */
11329
+ /** UPC or EAN code (max 15 chars) */
11308
11330
  upcOrEanId: string | null;
11309
11331
  /** Weight */
11310
11332
  weight: number | null;
@@ -11314,11 +11336,11 @@ interface InvMastListItem {
11314
11336
  width: number | null;
11315
11337
  /** Height */
11316
11338
  height: number | null;
11317
- /** Parker product code */
11339
+ /** Parker product code (max 255 chars) */
11318
11340
  parkerProductCd: string | null;
11319
- /** Brand name */
11341
+ /** Brand name (max 255 chars) */
11320
11342
  brandName: string | null;
11321
- /** Manufacturer name */
11343
+ /** Manufacturer name (max 255 chars) */
11322
11344
  manufacturerName: string | null;
11323
11345
  /** The item's suppliers (not deleted) */
11324
11346
  inventorySupplier: CategoriesItemsListDataItemsItemInventorySupplierItem[];
@@ -11626,7 +11648,7 @@ interface InvMastGetData {
11626
11648
  defaultSellingUnit: string | null;
11627
11649
  /** Y when the item is a hazardous material (max 1 chars) */
11628
11650
  hazMatFlag: string;
11629
- /** Search keywords (max 2147483647 chars) */
11651
+ /** Search keywords */
11630
11652
  keywords: string | null;
11631
11653
  /** Prophet 21 disposition code (max 1 chars) */
11632
11654
  disposition: string | null;
@@ -11920,9 +11942,9 @@ interface InvMastFaqListItem {
11920
11942
  invMastUid: number;
11921
11943
  /** The question (max 255 chars) */
11922
11944
  question: string;
11923
- /** The published answer (max 65535 chars) */
11945
+ /** The published answer */
11924
11946
  answer: string;
11925
- /** The machine-generated answer (max 65535 chars) */
11947
+ /** The machine-generated answer */
11926
11948
  generatedAnswer: string;
11927
11949
  /** Number of sources used to generate the answer */
11928
11950
  sourceCount: number;
@@ -11940,7 +11962,7 @@ interface InvMastFaqListItem {
11940
11962
  relatedQuestionsUid: number;
11941
11963
  /** Generate answer */
11942
11964
  generateCd: number;
11943
- /** Extra instructions used when generating the answer (max 65535 chars) */
11965
+ /** Extra instructions used when generating the answer */
11944
11966
  extraPrompt: string;
11945
11967
  /** Y/N flag: whether the answer was reviewed as accurate (max 1 chars) */
11946
11968
  accurateFlag: string;
@@ -11984,7 +12006,7 @@ interface InvMastFaqUpdateBody {
11984
12006
  generateCd?: number | null;
11985
12007
  /** Extra instructions used when generating the answer */
11986
12008
  extraPrompt?: string | null;
11987
- /** Y/N: whether the answer was reviewed as accurate */
12009
+ /** Y/N: whether the answer was reviewed as accurate (max 1 chars) */
11988
12010
  accurateFlag?: string | null;
11989
12011
  /** Quality score of the answer */
11990
12012
  qualityScore?: number | null;
@@ -12093,7 +12115,7 @@ interface InvMastLocationsBinsListItem {
12093
12115
  itemId: string;
12094
12116
  /** Prophet 21 location ID */
12095
12117
  locationId: number;
12096
- /** Bin */
12118
+ /** Bin (max 10 chars) */
12097
12119
  bin: string;
12098
12120
  /** Quantity in the bin */
12099
12121
  quantity: number;
@@ -12101,7 +12123,7 @@ interface InvMastLocationsBinsListItem {
12101
12123
  dateCreated: AttributeGroupsAttributesListItemDateCreated | null;
12102
12124
  /** When the row last changed (raw PHP DateTime object) */
12103
12125
  dateLastModified: AttributeGroupsAttributesListItemDateCreated | null;
12104
- /** User who last changed the row */
12126
+ /** User who last changed the row (max 30 chars) */
12105
12127
  lastMaintainedBy: string;
12106
12128
  [key: string]: unknown;
12107
12129
  }
@@ -12170,19 +12192,19 @@ type InvMastSimilarListData = InvMastSimilarListItem[];
12170
12192
  interface InvMastStockGetDataStockDataItem {
12171
12193
  /** Location ID */
12172
12194
  locationId: number;
12173
- /** Company the location belongs to */
12195
+ /** Company the location belongs to (max 8 chars) */
12174
12196
  companyId: string;
12175
12197
  /** Quantity on hand, in base units */
12176
12198
  qtyOnHand: number;
12177
12199
  /** Quantity allocated, in base units */
12178
12200
  qtyAllocated: number;
12179
- /** Y when the item is stocked at the location */
12201
+ /** Y when the item is stocked at the location (max 1 chars) */
12180
12202
  stockable: string | null;
12181
- /** Y when the item is sold from the location */
12203
+ /** Y when the item is sold from the location (max 1 chars) */
12182
12204
  sellable: string | null;
12183
- /** Y when the item is discontinued at the location */
12205
+ /** Y when the item is discontinued at the location (max 1 chars) */
12184
12206
  discontinued: string;
12185
- /** Y when the location record is deleted in P21 (inv_loc.delete_flag) */
12207
+ /** Y when the location record is deleted in P21 (inv_loc.delete_flag) (max 1 chars) */
12186
12208
  deleteFlag: string | null;
12187
12209
  /** qtyOnHand minus qtyAllocated */
12188
12210
  unallocated: number;
@@ -12190,7 +12212,7 @@ interface InvMastStockGetDataStockDataItem {
12190
12212
  nextDueInPoDate: string | null;
12191
12213
  /** Quantity backordered */
12192
12214
  qtyBackordered: number | null;
12193
- /** Primary bin */
12215
+ /** Primary bin (max 10 chars) */
12194
12216
  primaryBin: string | null;
12195
12217
  /** Quantity frozen */
12196
12218
  qtyFrozen: number;
@@ -12202,13 +12224,13 @@ interface InvMastStockGetDataStockDataItem {
12202
12224
  qtyAvailable: number;
12203
12225
  /** Order quantity */
12204
12226
  orderQuantity: number | null;
12205
- /** Product group at the location */
12227
+ /** Product group at the location (max 8 chars) */
12206
12228
  productGroupId: string | null;
12207
12229
  /** Item base unit */
12208
12230
  baseUnit: string;
12209
12231
  /** Base unit size (1 when unset) */
12210
12232
  baseUnitSize: number;
12211
- /** Item default selling unit */
12233
+ /** Item default selling unit (max 8 chars) */
12212
12234
  defaultSellingUnit: string | null;
12213
12235
  /** Default selling unit size */
12214
12236
  defaultSellingUnitSize: number;
@@ -12769,7 +12791,7 @@ interface VariantsListItem {
12769
12791
  id: string;
12770
12792
  /** Variant group description (max 255 chars) */
12771
12793
  description: string;
12772
- /** The 1536 dimensional vector that represents the variant data (max 4294967295 chars) */
12794
+ /** The 1536 dimensional vector that represents the variant data */
12773
12795
  vector: string | null;
12774
12796
  /** When the row was created (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
12775
12797
  dateCreated: string;
@@ -12783,7 +12805,7 @@ interface VariantsListItem {
12783
12805
  processCd: number;
12784
12806
  /** Hash of content; changes when the group content changes (max 64 chars) */
12785
12807
  contentHash: string | null;
12786
- /** Text built from the group items, used for the similarity vector (max 4294967295 chars) */
12808
+ /** Text built from the group items, used for the similarity vector */
12787
12809
  content: string | null;
12788
12810
  /** Vector code: 704 when the similarity vector needs a rebuild */
12789
12811
  vectorCd: number;
@@ -15945,15 +15967,15 @@ interface InvMastAlsoBoughtListItemInventorySupplierItem {
15945
15967
  invMastUid: number;
15946
15968
  /** Supplier ID */
15947
15969
  supplierId: number;
15948
- /** Supplier UPC code; empty when none */
15970
+ /** Supplier UPC code; empty when none (max 14 chars) */
15949
15971
  upcCode: string;
15950
- /** UPC check digit; empty when none */
15951
- checkDigit: string;
15972
+ /** UPC check digit (P21 decimal(1,0)); null when none */
15973
+ checkDigit: number | null;
15952
15974
  /** upcCode followed by checkDigit */
15953
15975
  upc: string;
15954
- /** Supplier part number */
15976
+ /** Supplier part number (max 40 chars) */
15955
15977
  supplierPartNo: string | null;
15956
- /** Y when this is the item's primary supplier */
15978
+ /** Y when this is the item's primary supplier (max 1 chars) */
15957
15979
  primarySupplierFlag: string | null;
15958
15980
  /** Supplier list price */
15959
15981
  listPrice: number | null;
@@ -15966,7 +15988,7 @@ interface InvMastAlsoBoughtListItemInventorySupplierItem {
15966
15988
  * Field `itemUom` of InvMastAlsoBoughtListItem
15967
15989
  */
15968
15990
  interface InvMastAlsoBoughtListItemItemUomItem {
15969
- /** Unit of measure code */
15991
+ /** Unit of measure code (max 8 chars) */
15970
15992
  unitOfMeasure: string;
15971
15993
  /** Base units per one of this unit */
15972
15994
  unitSize: number;
@@ -16109,25 +16131,27 @@ interface InvMastAlsoBoughtListItemAttributesItem {
16109
16131
  interface InvMastAlsoBoughtListItemStockStockDataItem {
16110
16132
  /** Location ID */
16111
16133
  locationId: number;
16112
- /** Company the location belongs to */
16134
+ /** Company the location belongs to (max 8 chars) */
16113
16135
  companyId: string;
16114
16136
  /** Quantity on hand, in base units */
16115
16137
  qtyOnHand: number;
16116
16138
  /** Quantity allocated, in base units */
16117
16139
  qtyAllocated: number;
16118
- /** Y when the item is stocked at the location */
16140
+ /** Y when the item is stocked at the location (max 1 chars) */
16119
16141
  stockable: string | null;
16120
- /** Y when the item is sold from the location */
16142
+ /** Y when the item is sold from the location (max 1 chars) */
16121
16143
  sellable: string | null;
16122
- /** Y when the item is discontinued at the location */
16144
+ /** Y when the item is discontinued at the location (max 1 chars) */
16123
16145
  discontinued: string;
16146
+ /** Y when the location record is deleted in P21 (inv_loc.delete_flag) (max 1 chars) */
16147
+ deleteFlag: string | null;
16124
16148
  /** qtyOnHand minus qtyAllocated */
16125
16149
  unallocated: number;
16126
16150
  /** Date (Y-m-d) the next purchase order is due in */
16127
16151
  nextDueInPoDate: string | null;
16128
16152
  /** Quantity backordered */
16129
16153
  qtyBackordered: number | null;
16130
- /** Primary bin */
16154
+ /** Primary bin (max 10 chars) */
16131
16155
  primaryBin: string | null;
16132
16156
  /** Quantity frozen */
16133
16157
  qtyFrozen: number;
@@ -16139,13 +16163,13 @@ interface InvMastAlsoBoughtListItemStockStockDataItem {
16139
16163
  qtyAvailable: number;
16140
16164
  /** Order quantity */
16141
16165
  orderQuantity: number | null;
16142
- /** Product group at the location */
16166
+ /** Product group at the location (max 8 chars) */
16143
16167
  productGroupId: string | null;
16144
16168
  /** Item base unit */
16145
16169
  baseUnit: string;
16146
16170
  /** Base unit size (1 when unset) */
16147
16171
  baseUnitSize: number;
16148
- /** Item default selling unit */
16172
+ /** Item default selling unit (max 8 chars) */
16149
16173
  defaultSellingUnit: string | null;
16150
16174
  /** Default selling unit size */
16151
16175
  defaultSellingUnitSize: number;
@@ -16287,55 +16311,55 @@ interface InvMastAlsoBoughtListItemFullSizedSamples {
16287
16311
  interface InvMastAlsoBoughtListItem {
16288
16312
  /** Item (inv_mast) ID */
16289
16313
  invMastUid: number;
16290
- /** Item ID */
16314
+ /** Item ID (max 40 chars) */
16291
16315
  itemId: string;
16292
- /** Item description */
16316
+ /** Item description (max 40 chars) */
16293
16317
  itemDesc: string | null;
16294
16318
  /** First web-displayed category description for the item */
16295
16319
  displayDesc: string | null;
16296
- /** Extended description */
16320
+ /** Extended description (max 255 chars) */
16297
16321
  extendedDesc: string | null;
16298
- /** Short code */
16322
+ /** Short code (max 30 chars) */
16299
16323
  shortCode: string | null;
16300
- /** Default selling unit */
16324
+ /** Default selling unit (max 8 chars) */
16301
16325
  defaultSellingUnit: string | null;
16302
- /** Default purchasing unit */
16326
+ /** Default purchasing unit (max 8 chars) */
16303
16327
  defaultPurchasingUnit: string | null;
16304
- /** Y when the item is deleted */
16328
+ /** Y when the item is deleted (max 1 chars) */
16305
16329
  deleteFlag: string;
16306
16330
  /** Online code (704 = online) */
16307
16331
  onlineCd: number;
16308
16332
  /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
16309
16333
  statusCd: number;
16310
- /** Base unit */
16334
+ /** Base unit (max 8 chars) */
16311
16335
  baseUnit: string;
16312
16336
  /** Vendor stock quantity */
16313
16337
  vndrStock: number | null;
16314
- /** Item class 1 */
16338
+ /** Item class 1 (max 8 chars) */
16315
16339
  classId1: string | null;
16316
- /** Item class 2 */
16340
+ /** Item class 2 (max 8 chars) */
16317
16341
  classId2: string | null;
16318
- /** Item class 3 */
16342
+ /** Item class 3 (max 8 chars) */
16319
16343
  classId3: string | null;
16320
- /** Item class 4 */
16344
+ /** Item class 4 (max 8 chars) */
16321
16345
  classId4: string | null;
16322
- /** Item class 5 */
16346
+ /** Item class 5 (max 8 chars) */
16323
16347
  classId5: string | null;
16324
- /** Y when the item is serialized */
16348
+ /** Y when the item is serialized (max 1 chars) */
16325
16349
  serialized: string;
16326
- /** Y when the item is lot-tracked */
16350
+ /** Y when the item is lot-tracked (max 1 chars) */
16327
16351
  trackLots: string;
16328
16352
  /** Tracking pattern derived from serialized and trackLots */
16329
16353
  trackingPattern: string;
16330
- /** Default product group */
16354
+ /** Default product group (max 8 chars) */
16331
16355
  defaultProductGroup: string | null;
16332
- /** Default sales discount group */
16356
+ /** Default sales discount group (max 8 chars) */
16333
16357
  defaultSalesDiscountGroup: string | null;
16334
- /** Default purchase discount group */
16358
+ /** Default purchase discount group (max 8 chars) */
16335
16359
  defaultPurchaseDiscGroup: string | null;
16336
- /** UPC or EAN code type */
16360
+ /** UPC or EAN code type (max 3 chars) */
16337
16361
  upcOrEan: string | null;
16338
- /** UPC or EAN code */
16362
+ /** UPC or EAN code (max 15 chars) */
16339
16363
  upcOrEanId: string | null;
16340
16364
  /** Weight */
16341
16365
  weight: number | null;
@@ -16345,11 +16369,11 @@ interface InvMastAlsoBoughtListItem {
16345
16369
  width: number | null;
16346
16370
  /** Height */
16347
16371
  height: number | null;
16348
- /** Parker product code */
16372
+ /** Parker product code (max 255 chars) */
16349
16373
  parkerProductCd: string | null;
16350
- /** Brand name */
16374
+ /** Brand name (max 255 chars) */
16351
16375
  brandName: string | null;
16352
- /** Manufacturer name */
16376
+ /** Manufacturer name (max 255 chars) */
16353
16377
  manufacturerName: string | null;
16354
16378
  /** The item's suppliers (not deleted) */
16355
16379
  inventorySupplier: InvMastAlsoBoughtListItemInventorySupplierItem[];
@@ -16373,8 +16397,8 @@ interface InvMastAlsoBoughtListItem {
16373
16397
  stock: InvMastAlsoBoughtListItemStock;
16374
16398
  /** Category display description per item category ID */
16375
16399
  categoryDisplayDescriptions: Record<string, string>;
16376
- /** Non-empty user-defined field values, keyed by field name ([] when empty) */
16377
- userDefined: Record<string, unknown> | [];
16400
+ /** Non-empty user-defined field values, keyed by field name; {} when the item has none */
16401
+ userDefined: Record<string, unknown>;
16378
16402
  /** Prophet 21 item text blocks (empty unless the site has a p21_pim config) */
16379
16403
  invMastText: InvMastAlsoBoughtListItemInvMastTextItem[];
16380
16404
  /** Descriptions in other languages */
@@ -16527,15 +16551,15 @@ interface InvMastWebDescListItem {
16527
16551
  invMastWebDescUid: number;
16528
16552
  /** Item (inv_mast) the web description belongs to */
16529
16553
  invMastUid: number;
16530
- /** Web description 1 (max 16777215 chars) */
16554
+ /** Web description 1 */
16531
16555
  webDesc1: string | null;
16532
- /** Web description 2 (max 16777215 chars) */
16556
+ /** Web description 2 */
16533
16557
  webDesc2: string | null;
16534
- /** Web description 3 (max 16777215 chars) */
16558
+ /** Web description 3 */
16535
16559
  webDesc3: string | null;
16536
- /** Web description 4 (max 16777215 chars) */
16560
+ /** Web description 4 */
16537
16561
  webDesc4: string | null;
16538
- /** Full web description (max 16777215 chars) */
16562
+ /** Full web description */
16539
16563
  webDescFull: string | null;
16540
16564
  /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
16541
16565
  dateCreated: string;
@@ -16644,7 +16668,7 @@ interface ItemCategoryGetData {
16644
16668
  itemCategoryId: string;
16645
16669
  /** Item category description (max 255 chars) */
16646
16670
  itemCategoryDesc: string;
16647
- /** Category article text 1 (max 16777215 chars) */
16671
+ /** Category article text 1 */
16648
16672
  article: string | null;
16649
16673
  /** Box folder ID for the category (max 255 chars) */
16650
16674
  boxFolderId: string | null;
@@ -16662,13 +16686,13 @@ interface ItemCategoryGetData {
16662
16686
  dateLastModified: string;
16663
16687
  /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
16664
16688
  dateLastChecked: string;
16665
- /** Category article text 2 (max 16777215 chars) */
16689
+ /** Category article text 2 */
16666
16690
  article2: string | null;
16667
- /** Category article text 3 (max 16777215 chars) */
16691
+ /** Category article text 3 */
16668
16692
  article3: string | null;
16669
- /** Category article text 4 (max 16777215 chars) */
16693
+ /** Category article text 4 */
16670
16694
  article4: string | null;
16671
- /** Category article text 5 (max 16777215 chars) */
16695
+ /** Category article text 5 */
16672
16696
  article5: string | null;
16673
16697
  /** Sample item ID shown for the category (max 255 chars) */
16674
16698
  sampleItemId: string | null;
@@ -16755,13 +16779,13 @@ type LegacyStateCreateData = LegacyStateListItem;
16755
16779
  * Request body of: api.legacy.legacy.state.create(data)
16756
16780
  */
16757
16781
  interface LegacyStateCreateBody {
16758
- /** State name */
16782
+ /** State name (max 255 chars) */
16759
16783
  stateName: string;
16760
- /** Two-letter state code */
16784
+ /** Two-letter state code (max 2 chars) */
16761
16785
  twoLetterCode: string;
16762
16786
  /** Country the state belongs to */
16763
16787
  countryUid?: number | null;
16764
- /** User who created the state; defaults to empty */
16788
+ /** User who created the state; defaults to empty (max 255 chars) */
16765
16789
  createdBy?: string | null;
16766
16790
  /** Combined Federal/State 1099 program number */
16767
16791
  combinedFederalState1099No?: number | null;
@@ -17543,9 +17567,9 @@ interface FyxerTranscriptListItem {
17543
17567
  fyxerTranscriptHdrUid: number;
17544
17568
  /** Recording link (max 255 chars) */
17545
17569
  link: string;
17546
- /** Meeting summary (max 4294967295 chars) */
17570
+ /** Meeting summary */
17547
17571
  summary: string | null;
17548
- /** Full transcript text (max 4294967295 chars) */
17572
+ /** Full transcript text */
17549
17573
  transcript: string | null;
17550
17574
  /** MySQL datetime format: YYYY-MM-DD HH:mm:ss (mysql-datetime, e.g. 2025-07-30 15:50:49) */
17551
17575
  dateRecorded: string;
@@ -17816,7 +17840,7 @@ type PostalCodesXShiptosCreateData = PostalCodesXShiptosListItem;
17816
17840
  * Request body of: api.agrSite.postalCodesXShiptos.create(data)
17817
17841
  */
17818
17842
  interface PostalCodesXShiptosCreateBody {
17819
- /** Postal code */
17843
+ /** Postal code (max 20 chars) */
17820
17844
  postalCode?: string | null;
17821
17845
  /** Prophet 21 ship-to ID */
17822
17846
  shipToId?: number | null;
@@ -17846,7 +17870,7 @@ type PostalCodesXShiptosUpdateData = PostalCodesXShiptosListItem;
17846
17870
  * Request body of: api.agrSite.postalCodesXShiptos.update(postalCodesXShiptosUid, data)
17847
17871
  */
17848
17872
  interface PostalCodesXShiptosUpdateBody {
17849
- /** Postal code */
17873
+ /** Postal code (max 20 chars) */
17850
17874
  postalCode?: string | null;
17851
17875
  /** Prophet 21 ship-to ID */
17852
17876
  shipToId?: number | null;
@@ -19167,9 +19191,9 @@ interface ContactsUdGetData {
19167
19191
  interface ContactsCustomersListItem {
19168
19192
  /** Prophet 21 customer ID */
19169
19193
  customerId: number;
19170
- /** Prophet 21 company */
19194
+ /** Prophet 21 company (max 8 chars) */
19171
19195
  companyId: string;
19172
- /** Customer name */
19196
+ /** Customer name (max 255 chars) */
19173
19197
  customerName: string | null;
19174
19198
  /** Customer class 1 */
19175
19199
  class1Id: string | null;
@@ -19181,23 +19205,23 @@ interface ContactsCustomersListItem {
19181
19205
  class4Id: string | null;
19182
19206
  /** Customer class 5 */
19183
19207
  class5Id: string | null;
19184
- /** Y when the customer may order on the web */
19208
+ /** Y when the customer may order on the web (max 1 chars) */
19185
19209
  webEnabledFlag: string;
19186
- /** Y when the customer is deleted in Prophet 21 */
19210
+ /** Y when the customer is deleted in Prophet 21 (max 1 chars) */
19187
19211
  deleteFlag: string;
19188
19212
  /** Prophet 21 contact ID of the customer's salesrep */
19189
19213
  salesRepId: string | null;
19190
- /** Y when orders require a purchase order number */
19214
+ /** Y when orders require a purchase order number (max 1 chars) */
19191
19215
  poNoRequired: string;
19192
- /** Prophet 21 payment terms */
19216
+ /** Prophet 21 payment terms (max 2 chars) */
19193
19217
  termsId: string | null;
19194
19218
  /** Payment terms description; empty when the customer has no terms */
19195
19219
  termsDesc: string;
19196
- /** Y when the customer is taxable */
19220
+ /** Y when the customer is taxable (max 1 chars) */
19197
19221
  taxableFlag: string;
19198
19222
  /** Augur status code */
19199
19223
  statusCd: number;
19200
- /** Y when the customer uses job pricing */
19224
+ /** Y when the customer uses job pricing (max 1 chars) */
19201
19225
  jobPricing: string;
19202
19226
  /**
19203
19227
  * Prophet 21 user-defined fields keyed by field name; [] when the customer has none ([] when
@@ -19217,29 +19241,29 @@ type ContactsCustomersListData = ContactsCustomersListItem[];
19217
19241
  interface ContactsDocListDataAddress {
19218
19242
  /** Prophet 21 address ID */
19219
19243
  id: number;
19220
- /** Physical address line 1 */
19244
+ /** Physical address line 1 (max 50 chars) */
19221
19245
  physAddress1: string | null;
19222
- /** Physical address line 2 */
19246
+ /** Physical address line 2 (max 50 chars) */
19223
19247
  physAddress2: string | null;
19224
- /** Physical city */
19248
+ /** Physical city (max 50 chars) */
19225
19249
  physCity: string | null;
19226
- /** Physical state or province */
19250
+ /** Physical state or province (max 50 chars) */
19227
19251
  physState: string | null;
19228
- /** Physical postal code */
19252
+ /** Physical postal code (max 10 chars) */
19229
19253
  physPostalCode: string | null;
19230
- /** Physical country */
19254
+ /** Physical country (max 50 chars) */
19231
19255
  physCountry: string | null;
19232
- /** Mailing address line 1 */
19256
+ /** Mailing address line 1 (max 50 chars) */
19233
19257
  mailAddress1: string | null;
19234
- /** Mailing address line 2 */
19258
+ /** Mailing address line 2 (max 50 chars) */
19235
19259
  mailAddress2: string | null;
19236
- /** Mailing city */
19260
+ /** Mailing city (max 50 chars) */
19237
19261
  mailCity: string | null;
19238
- /** Mailing state or province */
19262
+ /** Mailing state or province (max 50 chars) */
19239
19263
  mailState: string | null;
19240
- /** Mailing postal code */
19264
+ /** Mailing postal code (max 10 chars) */
19241
19265
  mailPostalCode: string | null;
19242
- /** Mailing country */
19266
+ /** Mailing country (max 50 chars) */
19243
19267
  mailCountry: string | null;
19244
19268
  [key: string]: unknown;
19245
19269
  }
@@ -19250,15 +19274,15 @@ interface ContactsDocListDataAddress {
19250
19274
  * Returned by: api.customers.contacts.doc.list(id)
19251
19275
  */
19252
19276
  interface ContactsDocListData {
19253
- /** Prophet 21 contact ID */
19277
+ /** Prophet 21 contact ID (max 16 chars) */
19254
19278
  id: string;
19255
- /** First name */
19279
+ /** First name (max 15 chars) */
19256
19280
  firstName: string;
19257
- /** Last name */
19281
+ /** Last name (max 24 chars) */
19258
19282
  lastName: string;
19259
- /** Email address */
19283
+ /** Email address (max 255 chars) */
19260
19284
  emailAddress: string | null;
19261
- /** Direct phone number */
19285
+ /** Direct phone number (max 20 chars) */
19262
19286
  directPhone: string | null;
19263
19287
  /** Contact role */
19264
19288
  contactRoleUid: number | null;
@@ -19320,7 +19344,7 @@ type CustomerListData = CustomerListItem[];
19320
19344
  interface CustomerLookupGetItem {
19321
19345
  /** Prophet 21 customer ID */
19322
19346
  customerId: number;
19323
- /** Customer name */
19347
+ /** Customer name (max 255 chars) */
19324
19348
  customerName: string | null;
19325
19349
  [key: string]: unknown;
19326
19350
  }
@@ -19335,19 +19359,19 @@ type CustomerLookupGetData = CustomerLookupGetItem[];
19335
19359
  interface CustomerAddressListItem {
19336
19360
  /** Prophet 21 address (ship-to) ID */
19337
19361
  id: number;
19338
- /** Address name */
19362
+ /** Address name (max 50 chars) */
19339
19363
  name: string;
19340
- /** Mailing address line 1 */
19364
+ /** Mailing address line 1 (max 50 chars) */
19341
19365
  mailAddress1: string;
19342
- /** Mailing address line 2 */
19366
+ /** Mailing address line 2 (max 50 chars) */
19343
19367
  mailAddress2: string | null;
19344
- /** Mailing city */
19368
+ /** Mailing city (max 50 chars) */
19345
19369
  mailCity: string | null;
19346
- /** Mailing state or province */
19370
+ /** Mailing state or province (max 50 chars) */
19347
19371
  mailState: string | null;
19348
- /** Mailing postal code */
19372
+ /** Mailing postal code (max 10 chars) */
19349
19373
  mailPostalCode: string | null;
19350
- /** Mailing country */
19374
+ /** Mailing country (max 50 chars) */
19351
19375
  mailCountry: string | null;
19352
19376
  [key: string]: unknown;
19353
19377
  }
@@ -19530,13 +19554,13 @@ interface CustomerAgingListDataTotalsItem {
19530
19554
  * Field `data` of CustomerAgingListData
19531
19555
  */
19532
19556
  interface CustomerAgingListDataDataItem {
19533
- /** Prophet 21 invoice number */
19557
+ /** Prophet 21 invoice number (max 10 chars) */
19534
19558
  invoiceNo: string;
19535
- /** Order the invoice was raised for */
19559
+ /** Order the invoice was raised for (max 8 chars) */
19536
19560
  orderNo: string | null;
19537
- /** Customer purchase order number */
19561
+ /** Customer purchase order number (max 255 chars) */
19538
19562
  poNo: string | null;
19539
- /** Ship-to name */
19563
+ /** Ship-to name (max 50 chars) */
19540
19564
  ship2Name: string | null;
19541
19565
  /** Invoice date the age is measured from (Y-m-d) */
19542
19566
  invoiceDate: string;
@@ -19582,21 +19606,21 @@ interface CustomerAgingListData {
19582
19606
  * Returned by: api.customers.customer.contacts.list(customerId, params) (array items)
19583
19607
  */
19584
19608
  interface CustomerContactsListItem {
19585
- /** Prophet 21 contact ID */
19609
+ /** Prophet 21 contact ID (max 16 chars) */
19586
19610
  id: string;
19587
- /** Email address */
19611
+ /** Email address (max 255 chars) */
19588
19612
  emailAddress: string | null;
19589
- /** First name */
19613
+ /** First name (max 15 chars) */
19590
19614
  firstName: string;
19591
- /** Last name */
19615
+ /** Last name (max 24 chars) */
19592
19616
  lastName: string;
19593
- /** Job title */
19617
+ /** Job title (max 40 chars) */
19594
19618
  title: string | null;
19595
19619
  /** Direct phone number */
19596
19620
  phone: string | null;
19597
19621
  /** Phone extension */
19598
19622
  ext: string | null;
19599
- /** Mobile phone number */
19623
+ /** Mobile phone number (max 20 chars) */
19600
19624
  cellular: string | null;
19601
19625
  /** Prophet 21 address the contact belongs to */
19602
19626
  addressId: number;
@@ -19648,13 +19672,13 @@ interface CustomerInvoicesListItemLinesItem {
19648
19672
  lineNo: number;
19649
19673
  /** Item (inv_mast) on the line; null for a non-stock line */
19650
19674
  invMastUid: number | null;
19651
- /** Item ID */
19675
+ /** Item ID (max 40 chars) */
19652
19676
  itemId: string | null;
19653
- /** Item description */
19677
+ /** Item description (max 40 chars) */
19654
19678
  itemDesc: string;
19655
19679
  /** Item short code; null when the line has no item */
19656
19680
  shortCode: string | null;
19657
- /** Unit of measure */
19681
+ /** Unit of measure (max 10 chars) */
19658
19682
  unitOfMeasure: string | null;
19659
19683
  /** Unit price */
19660
19684
  unitPrice: number;
@@ -19666,7 +19690,7 @@ interface CustomerInvoicesListItemLinesItem {
19666
19690
  qtyShipped: number;
19667
19691
  /** Order the line came from; misspelled duplicate of orderNo, kept for existing consumers */
19668
19692
  oderNo: string | null;
19669
- /** Order the line came from */
19693
+ /** Order the line came from (max 8 chars) */
19670
19694
  orderNo: string | null;
19671
19695
  /** Order line number the invoice line came from */
19672
19696
  oeLineNumber: number | null;
@@ -19680,63 +19704,63 @@ interface CustomerInvoicesListItemLinesItem {
19680
19704
  * Returned by: api.customers.customer.invoices.get(customerId, invoiceNo)
19681
19705
  */
19682
19706
  interface CustomerInvoicesListItem {
19683
- /** Invoice number */
19707
+ /** Invoice number (max 10 chars) */
19684
19708
  invoiceNo: string;
19685
19709
  /** Prophet 21 customer invoiced */
19686
19710
  customerId: number;
19687
19711
  /** Customer name */
19688
19712
  customerName: string | null;
19689
- /** Order the invoice bills */
19713
+ /** Order the invoice bills (max 8 chars) */
19690
19714
  orderNo: string | null;
19691
19715
  /** Invoice date (Y-m-d) */
19692
19716
  invoiceDate: string;
19693
- /** Customer purchase order number */
19717
+ /** Customer purchase order number (max 255 chars) */
19694
19718
  poNo: string | null;
19695
- /** Ship-to name */
19719
+ /** Ship-to name (max 50 chars) */
19696
19720
  ship2Name: string | null;
19697
- /** Ship-to contact */
19721
+ /** Ship-to contact (max 30 chars) */
19698
19722
  ship2Contact: string | null;
19699
- /** Ship-to address line 1 */
19723
+ /** Ship-to address line 1 (max 50 chars) */
19700
19724
  ship2Address1: string | null;
19701
- /** Ship-to address line 2 */
19725
+ /** Ship-to address line 2 (max 50 chars) */
19702
19726
  ship2Address2: string | null;
19703
- /** Ship-to address line 3 */
19727
+ /** Ship-to address line 3 (max 50 chars) */
19704
19728
  ship2Address3: string | null;
19705
- /** Ship-to city */
19729
+ /** Ship-to city (max 50 chars) */
19706
19730
  ship2City: string | null;
19707
- /** Ship-to state or province */
19731
+ /** Ship-to state or province (max 50 chars) */
19708
19732
  ship2State: string | null;
19709
- /** Ship-to postal code */
19733
+ /** Ship-to postal code (max 10 chars) */
19710
19734
  ship2PostalCode: string | null;
19711
- /** Ship-to country */
19735
+ /** Ship-to country (max 50 chars) */
19712
19736
  ship2Country: string | null;
19713
- /** Ship-to email address */
19737
+ /** Ship-to email address (max 255 chars) */
19714
19738
  ship2EmailAddress: string | null;
19715
- /** Ship-to phone number */
19739
+ /** Ship-to phone number (max 20 chars) */
19716
19740
  shipToPhone: string | null;
19717
- /** Bill-to name */
19741
+ /** Bill-to name (max 50 chars) */
19718
19742
  bill2Name: string | null;
19719
- /** Bill-to contact */
19743
+ /** Bill-to contact (max 30 chars) */
19720
19744
  bill2Contact: string | null;
19721
- /** Bill-to address line 1 */
19745
+ /** Bill-to address line 1 (max 50 chars) */
19722
19746
  bill2Address1: string | null;
19723
- /** Bill-to address line 2 */
19747
+ /** Bill-to address line 2 (max 50 chars) */
19724
19748
  bill2Address2: string | null;
19725
- /** Bill-to address line 3 */
19749
+ /** Bill-to address line 3 (max 50 chars) */
19726
19750
  bill2Address3: string | null;
19727
- /** Bill-to city */
19751
+ /** Bill-to city (max 50 chars) */
19728
19752
  bill2City: string | null;
19729
- /** Bill-to state or province */
19753
+ /** Bill-to state or province (max 50 chars) */
19730
19754
  bill2State: string | null;
19731
- /** Bill-to postal code */
19755
+ /** Bill-to postal code (max 10 chars) */
19732
19756
  bill2PostalCode: string | null;
19733
- /** Bill-to country */
19757
+ /** Bill-to country (max 50 chars) */
19734
19758
  bill2Country: string | null;
19735
19759
  /** Invoice total */
19736
19760
  totalAmount: number;
19737
19761
  /** Amount paid so far */
19738
19762
  amountPaid: number;
19739
- /** Y when the invoice is paid in full */
19763
+ /** Y when the invoice is paid in full (max 1 chars) */
19740
19764
  paidInFullFlag: string | null;
19741
19765
  /** Tax on the invoice */
19742
19766
  taxAmount: number;
@@ -20023,13 +20047,13 @@ type CustomerOrdersListData = Array<CustomerOrdersGetData | CustomerOrdersListDa
20023
20047
  interface CustomerOrdersGetDataLinesItem {
20024
20048
  /** Item (inv_mast) ordered on the line */
20025
20049
  invMastUid: number;
20026
- /** Y when the line is canceled */
20050
+ /** Y when the line is canceled (max 1 chars) */
20027
20051
  cancelFlag: string | null;
20028
- /** Y when the line is complete */
20052
+ /** Y when the line is complete (max 1 chars) */
20029
20053
  complete: string | null;
20030
- /** Y when the line is deleted in Prophet 21 */
20054
+ /** Y when the line is deleted in Prophet 21 (max 1 chars) */
20031
20055
  deleteFlag: string;
20032
- /** Prophet 21 disposition code for unallocated quantity (e.g. B = backorder) */
20056
+ /** Prophet 21 disposition code for unallocated quantity (e.g. B = backorder) (max 1 chars) */
20033
20057
  disposition: string | null;
20034
20058
  /** Item description */
20035
20059
  itemDesc: string | null;
@@ -20041,7 +20065,7 @@ interface CustomerOrdersGetDataLinesItem {
20041
20065
  shortCode: string | null;
20042
20066
  /** Line number on the order */
20043
20067
  lineNo: number;
20044
- /** Order the line belongs to */
20068
+ /** Order the line belongs to (max 8 chars) */
20045
20069
  orderNo: string;
20046
20070
  /** Quantity on the line when it was entered */
20047
20071
  originalQtyOrdered: number | null;
@@ -20055,7 +20079,7 @@ interface CustomerOrdersGetDataLinesItem {
20055
20079
  qtyOnPickTickets: number | null;
20056
20080
  /** Quantity ordered */
20057
20081
  qtyOrdered: number | null;
20058
- /** Unit of measure the line was sold in */
20082
+ /** Unit of measure the line was sold in (max 8 chars) */
20059
20083
  unitOfMeasure: string | null;
20060
20084
  /** Quantity in the line's unit of measure */
20061
20085
  unitQuantity: number;
@@ -20119,19 +20143,19 @@ interface CustomerOrdersGetDataPickTicketsItemLinesItem {
20119
20143
  interface CustomerOrdersGetDataPickTicketsItem {
20120
20144
  /** Pick ticket number */
20121
20145
  pickTicketNo: number;
20122
- /** Carrier tracking number */
20146
+ /** Carrier tracking number (max 40 chars) */
20123
20147
  trackingNo: string | null;
20124
- /** Order the pick ticket belongs to */
20148
+ /** Order the pick ticket belongs to (max 8 chars) */
20125
20149
  orderNo: string;
20126
20150
  /** Invoice raised for the pick ticket; null until invoiced */
20127
20151
  invoiceNo: number | null;
20128
20152
  /** Date the pick ticket shipped (Y-m-d) */
20129
20153
  shipDate: string | null;
20130
- /** Y when the pick ticket has been printed */
20154
+ /** Y when the pick ticket has been printed (max 1 chars) */
20131
20155
  printedFlag: string | null;
20132
20156
  /** Date the pick ticket was printed (Y-m-d) */
20133
20157
  printDate: string | null;
20134
- /** Picking or shipping instructions */
20158
+ /** Picking or shipping instructions (max 255 chars) */
20135
20159
  instructions: string | null;
20136
20160
  /** Prophet 21 address id of the pick ticket's carrier */
20137
20161
  carrierId: number | null;
@@ -20154,47 +20178,47 @@ interface CustomerOrdersGetDataPickTicketsItem {
20154
20178
  * Returned by: api.customers.customer.rmas.get(customerId, rmaNo)
20155
20179
  */
20156
20180
  interface CustomerOrdersGetData {
20157
- /** Prophet 21 order number */
20181
+ /** Prophet 21 order number (max 8 chars) */
20158
20182
  orderNo: string;
20159
20183
  /** Prophet 21 customer the order belongs to */
20160
20184
  customerId: number;
20161
20185
  /** Customer name */
20162
20186
  customerName: string | null;
20163
- /** Job name entered on the order */
20187
+ /** Job name entered on the order (max 40 chars) */
20164
20188
  jobName: string | null;
20165
20189
  /** Date the order was placed (Y-m-d) */
20166
20190
  orderDate: string | null;
20167
20191
  /** Date the customer requested delivery (Y-m-d) */
20168
20192
  requestedDate: string | null;
20169
- /** Y when the order is canceled */
20193
+ /** Y when the order is canceled (max 1 chars) */
20170
20194
  cancelFlag: string | null;
20171
- /** Y when the order is complete (fully shipped) */
20195
+ /** Y when the order is complete (fully shipped) (max 1 chars) */
20172
20196
  completed: string | null;
20173
- /** Y when the order is deleted in Prophet 21 */
20197
+ /** Y when the order is deleted in Prophet 21 (max 1 chars) */
20174
20198
  deleteFlag: string;
20175
- /** Customer purchase order number */
20199
+ /** Customer purchase order number (max 50 chars) */
20176
20200
  poNo: string | null;
20177
- /** Ship-to name */
20201
+ /** Ship-to name (max 50 chars) */
20178
20202
  ship2Name: string | null;
20179
- /** Ship-to address line 1 */
20203
+ /** Ship-to address line 1 (max 50 chars) */
20180
20204
  ship2Add1: string | null;
20181
- /** Ship-to address line 2 */
20205
+ /** Ship-to address line 2 (max 50 chars) */
20182
20206
  ship2Add2: string | null;
20183
- /** Ship-to address line 3 */
20207
+ /** Ship-to address line 3 (max 50 chars) */
20184
20208
  ship2Add3: string | null;
20185
- /** Ship-to city */
20209
+ /** Ship-to city (max 50 chars) */
20186
20210
  ship2City: string | null;
20187
- /** Ship-to state or province */
20211
+ /** Ship-to state or province (max 50 chars) */
20188
20212
  ship2State: string | null;
20189
- /** Ship-to postal code */
20213
+ /** Ship-to postal code (max 10 chars) */
20190
20214
  ship2Zip: string | null;
20191
- /** Ship-to country */
20215
+ /** Ship-to country (max 50 chars) */
20192
20216
  ship2Country: string | null;
20193
- /** Ship-to email address */
20217
+ /** Ship-to email address (max 255 chars) */
20194
20218
  ship2EmailAddress: string | null;
20195
- /** Ship-to phone number */
20219
+ /** Ship-to phone number (max 20 chars) */
20196
20220
  shipToPhone: string | null;
20197
- /** Delivery instructions for the carrier */
20221
+ /** Delivery instructions for the carrier (max 255 chars) */
20198
20222
  deliveryInstructions: string | null;
20199
20223
  /** Order class 1 */
20200
20224
  class1Id: string | null;
@@ -20206,16 +20230,16 @@ interface CustomerOrdersGetData {
20206
20230
  class4Id: string | null;
20207
20231
  /** Order class 5 */
20208
20232
  class5Id: string | null;
20209
- /** Prophet 21 contact who placed the order */
20233
+ /** Prophet 21 contact who placed the order (max 16 chars) */
20210
20234
  contactId: string | null;
20211
- /** Web order reference number from the storefront */
20235
+ /** Web order reference number from the storefront (max 255 chars) */
20212
20236
  webReferenceNo: string | null;
20213
20237
  /**
20214
20238
  * PENDING, SUBMITTED, IN PROCESS, ON HOLD or SHIPPED, derived from the completed, approved,
20215
20239
  * cancel and validation flags
20216
20240
  */
20217
20241
  orderStatus: string;
20218
- /** User who entered the order */
20242
+ /** User who entered the order (max 30 chars) */
20219
20243
  taker: string | null;
20220
20244
  /** First name of the ordering contact; null when the order has no contact */
20221
20245
  contactFirstName: string | null;
@@ -20318,11 +20342,11 @@ interface CustomerSalesUsageListDataDataItemBucketsItem {
20318
20342
  * Field `data` of CustomerSalesUsageListData
20319
20343
  */
20320
20344
  interface CustomerSalesUsageListDataDataItem {
20321
- /** Item ID */
20345
+ /** Item ID (max 40 chars) */
20322
20346
  itemId: string;
20323
- /** Item description */
20347
+ /** Item description (max 40 chars) */
20324
20348
  itemDesc: string;
20325
- /** Unit of measure the item was sold in */
20349
+ /** Unit of measure the item was sold in (max 10 chars) */
20326
20350
  unitOfMeasure: string | null;
20327
20351
  /** Base units per sales unit */
20328
20352
  salesUnitSize: number | null;
@@ -20386,41 +20410,41 @@ interface CustomerShipToCreateBody {
20386
20410
  interface CustomerShipToListItemAddress {
20387
20411
  /** Prophet 21 address ID */
20388
20412
  id: number;
20389
- /** Address name */
20413
+ /** Address name (max 50 chars) */
20390
20414
  name: string;
20391
- /** Mailing address line 1 */
20415
+ /** Mailing address line 1 (max 50 chars) */
20392
20416
  mailAddress1: string | null;
20393
- /** Mailing address line 2 */
20417
+ /** Mailing address line 2 (max 50 chars) */
20394
20418
  mailAddress2: string | null;
20395
- /** Mailing address line 3 */
20419
+ /** Mailing address line 3 (max 50 chars) */
20396
20420
  mailAddress3: string | null;
20397
- /** Mailing city */
20421
+ /** Mailing city (max 50 chars) */
20398
20422
  mailCity: string | null;
20399
- /** Mailing state or province */
20423
+ /** Mailing state or province (max 50 chars) */
20400
20424
  mailState: string | null;
20401
- /** Mailing postal code */
20425
+ /** Mailing postal code (max 10 chars) */
20402
20426
  mailPostalCode: string | null;
20403
- /** Mailing country */
20427
+ /** Mailing country (max 50 chars) */
20404
20428
  mailCountry: string | null;
20405
- /** Physical address line 1 */
20429
+ /** Physical address line 1 (max 50 chars) */
20406
20430
  physAddress1: string | null;
20407
- /** Physical address line 2 */
20431
+ /** Physical address line 2 (max 50 chars) */
20408
20432
  physAddress2: string | null;
20409
- /** Physical address line 3 */
20433
+ /** Physical address line 3 (max 50 chars) */
20410
20434
  physAddress3: string | null;
20411
- /** Physical city */
20435
+ /** Physical city (max 50 chars) */
20412
20436
  physCity: string | null;
20413
- /** Physical state or province */
20437
+ /** Physical state or province (max 50 chars) */
20414
20438
  physState: string | null;
20415
- /** Physical postal code */
20439
+ /** Physical postal code (max 10 chars) */
20416
20440
  physPostalCode: string | null;
20417
- /** Physical country */
20441
+ /** Physical country (max 50 chars) */
20418
20442
  physCountry: string | null;
20419
- /** Address class 5 */
20443
+ /** Address class 5 (max 8 chars) */
20420
20444
  class5Id: string | null;
20421
- /** Main phone number */
20445
+ /** Main phone number (max 20 chars) */
20422
20446
  centralPhoneNumber: string | null;
20423
- /** UPS code for the address */
20447
+ /** UPS code for the address (max 40 chars) */
20424
20448
  upsCode: string | null;
20425
20449
  [key: string]: unknown;
20426
20450
  }
@@ -20435,15 +20459,15 @@ interface CustomerShipToListItem {
20435
20459
  shipToId: number;
20436
20460
  /** Prophet 21 customer the ship-to belongs to */
20437
20461
  customerId: number;
20438
- /** Prophet 21 company */
20462
+ /** Prophet 21 company (max 8 chars) */
20439
20463
  companyId: string;
20440
- /** Default branch for the ship-to */
20464
+ /** Default branch for the ship-to (max 8 chars) */
20441
20465
  defaultBranch: string;
20442
20466
  /** Prophet 21 address ID of the default carrier */
20443
20467
  defaultCarrierId: number | null;
20444
20468
  /** Prophet 21 location the ship-to prefers to ship from */
20445
20469
  preferredLocationId: number | null;
20446
- /** Delivery instructions for the carrier */
20470
+ /** Delivery instructions for the carrier (max 255 chars) */
20447
20471
  deliveryInstructions: string | null;
20448
20472
  /** Shipping route assigned to the ship-to */
20449
20473
  shippingRouteUid: number | null;
@@ -20466,41 +20490,41 @@ type CustomerShipToListData = CustomerShipToListItem[];
20466
20490
  interface CustomerShipToLookupGetItem {
20467
20491
  /** Prophet 21 ship-to (address) ID */
20468
20492
  id: number;
20469
- /** Ship-to name */
20493
+ /** Ship-to name (max 50 chars) */
20470
20494
  name: string;
20471
- /** Mailing address line 1 */
20495
+ /** Mailing address line 1 (max 50 chars) */
20472
20496
  mailAddress1: string;
20473
- /** Mailing address line 2 */
20497
+ /** Mailing address line 2 (max 50 chars) */
20474
20498
  mailAddress2: string | null;
20475
- /** Mailing address line 3 */
20499
+ /** Mailing address line 3 (max 50 chars) */
20476
20500
  mailAddress3: string | null;
20477
- /** Mailing city */
20501
+ /** Mailing city (max 50 chars) */
20478
20502
  mailCity: string | null;
20479
- /** Mailing state or province */
20503
+ /** Mailing state or province (max 50 chars) */
20480
20504
  mailState: string | null;
20481
- /** Mailing postal code */
20505
+ /** Mailing postal code (max 10 chars) */
20482
20506
  mailPostalCode: string | null;
20483
- /** Mailing country */
20507
+ /** Mailing country (max 50 chars) */
20484
20508
  mailCountry: string | null;
20485
- /** Physical address line 1 */
20509
+ /** Physical address line 1 (max 50 chars) */
20486
20510
  physAddress1: string | null;
20487
- /** Physical address line 2 */
20511
+ /** Physical address line 2 (max 50 chars) */
20488
20512
  physAddress2: string | null;
20489
- /** Physical address line 3 */
20513
+ /** Physical address line 3 (max 50 chars) */
20490
20514
  physAddress3: string | null;
20491
- /** Physical city */
20515
+ /** Physical city (max 50 chars) */
20492
20516
  physCity: string | null;
20493
- /** Physical state or province */
20517
+ /** Physical state or province (max 50 chars) */
20494
20518
  physState: string | null;
20495
- /** Physical postal code */
20519
+ /** Physical postal code (max 10 chars) */
20496
20520
  physPostalCode: string | null;
20497
- /** Physical country */
20521
+ /** Physical country (max 50 chars) */
20498
20522
  physCountry: string | null;
20499
- /** Address class 5 */
20523
+ /** Address class 5 (max 8 chars) */
20500
20524
  class5Id: string | null;
20501
20525
  /** Prophet 21 location the ship-to prefers to ship from */
20502
20526
  preferredLocationId: number | null;
20503
- /** Default branch for the ship-to */
20527
+ /** Default branch for the ship-to (max 8 chars) */
20504
20528
  defaultBranch: string;
20505
20529
  [key: string]: unknown;
20506
20530
  }
@@ -20714,7 +20738,7 @@ interface CustomersClientSpec {
20714
20738
  * @param params ContactsCustomersListParams (query string)
20715
20739
  * @returns BaseResponse whose `data` is ContactsCustomersListData
20716
20740
  */
20717
- list: (id: number, params?: ContactsCustomersListParams) => Promise<BaseResponse$1<ContactsCustomersListData>>;
20741
+ list: (id: string, params?: ContactsCustomersListParams) => Promise<BaseResponse$1<ContactsCustomersListData>>;
20718
20742
  };
20719
20743
  doc: {
20720
20744
  /**
@@ -20733,9 +20757,9 @@ interface CustomersClientSpec {
20733
20757
  * @param params ContactsDocListParams (query string)
20734
20758
  * @returns BaseResponse whose `data` is ContactsDocListData
20735
20759
  */
20736
- list: (id: number, params?: ContactsDocListParams) => Promise<BaseResponse$1<ContactsDocListData>>;
20760
+ list: (id: string, params?: ContactsDocListParams) => Promise<BaseResponse$1<ContactsDocListData>>;
20737
20761
  /** Alias for `list`: GET /contacts/{id}/doc. Call: api.customers.contacts.doc.get(id) */
20738
- get: (id: number, params?: ContactsDocListParams) => Promise<BaseResponse$1<ContactsDocListData>>;
20762
+ get: (id: string, params?: ContactsDocListParams) => Promise<BaseResponse$1<ContactsDocListData>>;
20739
20763
  };
20740
20764
  webAllowance: {
20741
20765
  /**
@@ -20756,7 +20780,7 @@ interface CustomersClientSpec {
20756
20780
  * @param params ContactsWebAllowanceListParams (query string)
20757
20781
  * @returns BaseResponse whose `data` is ContactsWebAllowanceListData
20758
20782
  */
20759
- list: (id: number, params?: ContactsWebAllowanceListParams) => Promise<BaseResponse$1<ContactsWebAllowanceListData>>;
20783
+ list: (id: string, params?: ContactsWebAllowanceListParams) => Promise<BaseResponse$1<ContactsWebAllowanceListData>>;
20760
20784
  };
20761
20785
  };
20762
20786
  contactsUd: {
@@ -20777,7 +20801,7 @@ interface CustomersClientSpec {
20777
20801
  * @param params ContactsUdGetParams (query string)
20778
20802
  * @returns BaseResponse whose `data` is ContactsUdGetData
20779
20803
  */
20780
- get: (id: number, params?: ContactsUdGetParams) => Promise<BaseResponse$1<ContactsUdGetData>>;
20804
+ get: (id: string, params?: ContactsUdGetParams) => Promise<BaseResponse$1<ContactsUdGetData>>;
20781
20805
  };
20782
20806
  customer: {
20783
20807
  /**
@@ -21750,29 +21774,29 @@ type InvoiceHdrReprintListData = InvoiceHdrReprintListDataOption1 | false;
21750
21774
  interface OeHdrLookupGetItem {
21751
21775
  /** Order header ID */
21752
21776
  oeHdrUid: number;
21753
- /** Prophet 21 order number */
21777
+ /** Prophet 21 order number (max 8 chars) */
21754
21778
  orderNo: string;
21755
- /** Customer purchase order number */
21779
+ /** Customer purchase order number (max 50 chars) */
21756
21780
  poNo: string | null;
21757
21781
  /** Prophet 21 customer the order belongs to */
21758
21782
  customerId: number;
21759
- /** Ship-to name */
21783
+ /** Ship-to name (max 50 chars) */
21760
21784
  ship2Name: string | null;
21761
- /** Ship-to email address */
21785
+ /** Ship-to email address (max 255 chars) */
21762
21786
  ship2EmailAddress: string | null;
21763
- /** Web order reference number from the storefront */
21787
+ /** Web order reference number from the storefront (max 255 chars) */
21764
21788
  webReferenceNo: string | null;
21765
21789
  /** Customer name */
21766
21790
  customerName: string | null;
21767
- /** Y when the order is complete (fully shipped) */
21791
+ /** Y when the order is complete (fully shipped) (max 1 chars) */
21768
21792
  completed: string | null;
21769
21793
  /** Date the order was placed (Y-m-d); empty when unknown */
21770
21794
  orderDate: string;
21771
- /** User who entered the order */
21795
+ /** User who entered the order (max 30 chars) */
21772
21796
  taker: string | null;
21773
21797
  /** Order class 1 */
21774
21798
  class1Id: string | null;
21775
- /** Job name entered on the order */
21799
+ /** Job name entered on the order (max 40 chars) */
21776
21800
  jobName: string | null;
21777
21801
  /**
21778
21802
  * PENDING, SUBMITTED, IN PROCESS, ON HOLD or SHIPPED, derived from the completed, approved,
@@ -21792,13 +21816,13 @@ type OeHdrLookupGetData = OeHdrLookupGetItem[];
21792
21816
  interface OeHdrDocListDataLinesItem {
21793
21817
  /** Item (inv_mast) ordered on the line */
21794
21818
  invMastUid: number;
21795
- /** Y when the line is canceled */
21819
+ /** Y when the line is canceled (max 1 chars) */
21796
21820
  cancelFlag: string | null;
21797
- /** Y when the line is complete */
21821
+ /** Y when the line is complete (max 1 chars) */
21798
21822
  complete: string | null;
21799
- /** Y when the line is deleted in Prophet 21 */
21823
+ /** Y when the line is deleted in Prophet 21 (max 1 chars) */
21800
21824
  deleteFlag: string;
21801
- /** Prophet 21 disposition code for unallocated quantity (e.g. B = backorder) */
21825
+ /** Prophet 21 disposition code for unallocated quantity (e.g. B = backorder) (max 1 chars) */
21802
21826
  disposition: string | null;
21803
21827
  /** Item description */
21804
21828
  itemDesc: string | null;
@@ -21810,7 +21834,7 @@ interface OeHdrDocListDataLinesItem {
21810
21834
  shortCode: string | null;
21811
21835
  /** Line number on the order */
21812
21836
  lineNo: number;
21813
- /** Order the line belongs to */
21837
+ /** Order the line belongs to (max 8 chars) */
21814
21838
  orderNo: string;
21815
21839
  /** Quantity on the line when it was entered */
21816
21840
  originalQtyOrdered: number | null;
@@ -21824,7 +21848,7 @@ interface OeHdrDocListDataLinesItem {
21824
21848
  qtyOnPickTickets: number | null;
21825
21849
  /** Quantity ordered */
21826
21850
  qtyOrdered: number | null;
21827
- /** Unit of measure the line was sold in */
21851
+ /** Unit of measure the line was sold in (max 8 chars) */
21828
21852
  unitOfMeasure: string | null;
21829
21853
  /** Quantity in the line's unit of measure */
21830
21854
  unitQuantity: number;
@@ -21888,19 +21912,19 @@ interface OeHdrDocListDataPickTicketsItemLinesItem {
21888
21912
  interface OeHdrDocListDataPickTicketsItem {
21889
21913
  /** Pick ticket number */
21890
21914
  pickTicketNo: number;
21891
- /** Carrier tracking number */
21915
+ /** Carrier tracking number (max 40 chars) */
21892
21916
  trackingNo: string | null;
21893
- /** Order the pick ticket belongs to */
21917
+ /** Order the pick ticket belongs to (max 8 chars) */
21894
21918
  orderNo: string;
21895
21919
  /** Invoice raised for the pick ticket; null until invoiced */
21896
21920
  invoiceNo: number | null;
21897
21921
  /** Date the pick ticket shipped (Y-m-d) */
21898
21922
  shipDate: string | null;
21899
- /** Y when the pick ticket has been printed */
21923
+ /** Y when the pick ticket has been printed (max 1 chars) */
21900
21924
  printedFlag: string | null;
21901
21925
  /** Date the pick ticket was printed (Y-m-d) */
21902
21926
  printDate: string | null;
21903
- /** Picking or shipping instructions */
21927
+ /** Picking or shipping instructions (max 255 chars) */
21904
21928
  instructions: string | null;
21905
21929
  /** Prophet 21 address id of the pick ticket's carrier */
21906
21930
  carrierId: number | null;
@@ -21917,47 +21941,47 @@ interface OeHdrDocListDataPickTicketsItem {
21917
21941
  * Returned by: api.orders.oeHdr.doc.list(orderNo, params)
21918
21942
  */
21919
21943
  interface OeHdrDocListData {
21920
- /** Prophet 21 order number */
21944
+ /** Prophet 21 order number (max 8 chars) */
21921
21945
  orderNo: string;
21922
21946
  /** Prophet 21 customer the order belongs to */
21923
21947
  customerId: number;
21924
21948
  /** Customer name */
21925
21949
  customerName: string | null;
21926
- /** Job name entered on the order */
21950
+ /** Job name entered on the order (max 40 chars) */
21927
21951
  jobName: string | null;
21928
21952
  /** Date the order was placed (Y-m-d) */
21929
21953
  orderDate: string | null;
21930
21954
  /** Date the customer requested delivery (Y-m-d) */
21931
21955
  requestedDate: string | null;
21932
- /** Y when the order is canceled */
21956
+ /** Y when the order is canceled (max 1 chars) */
21933
21957
  cancelFlag: string | null;
21934
- /** Y when the order is complete (fully shipped) */
21958
+ /** Y when the order is complete (fully shipped) (max 1 chars) */
21935
21959
  completed: string | null;
21936
- /** Y when the order is deleted in Prophet 21 */
21960
+ /** Y when the order is deleted in Prophet 21 (max 1 chars) */
21937
21961
  deleteFlag: string;
21938
- /** Customer purchase order number */
21962
+ /** Customer purchase order number (max 50 chars) */
21939
21963
  poNo: string | null;
21940
- /** Ship-to name */
21964
+ /** Ship-to name (max 50 chars) */
21941
21965
  ship2Name: string | null;
21942
- /** Ship-to address line 1 */
21966
+ /** Ship-to address line 1 (max 50 chars) */
21943
21967
  ship2Add1: string | null;
21944
- /** Ship-to address line 2 */
21968
+ /** Ship-to address line 2 (max 50 chars) */
21945
21969
  ship2Add2: string | null;
21946
- /** Ship-to address line 3 */
21970
+ /** Ship-to address line 3 (max 50 chars) */
21947
21971
  ship2Add3: string | null;
21948
- /** Ship-to city */
21972
+ /** Ship-to city (max 50 chars) */
21949
21973
  ship2City: string | null;
21950
- /** Ship-to state or province */
21974
+ /** Ship-to state or province (max 50 chars) */
21951
21975
  ship2State: string | null;
21952
- /** Ship-to postal code */
21976
+ /** Ship-to postal code (max 10 chars) */
21953
21977
  ship2Zip: string | null;
21954
- /** Ship-to country */
21978
+ /** Ship-to country (max 50 chars) */
21955
21979
  ship2Country: string | null;
21956
- /** Ship-to email address */
21980
+ /** Ship-to email address (max 255 chars) */
21957
21981
  ship2EmailAddress: string | null;
21958
- /** Ship-to phone number */
21982
+ /** Ship-to phone number (max 20 chars) */
21959
21983
  shipToPhone: string | null;
21960
- /** Delivery instructions for the carrier */
21984
+ /** Delivery instructions for the carrier (max 255 chars) */
21961
21985
  deliveryInstructions: string | null;
21962
21986
  /** Order class 1 */
21963
21987
  class1Id: string | null;
@@ -21969,16 +21993,16 @@ interface OeHdrDocListData {
21969
21993
  class4Id: string | null;
21970
21994
  /** Order class 5 */
21971
21995
  class5Id: string | null;
21972
- /** Prophet 21 contact who placed the order */
21996
+ /** Prophet 21 contact who placed the order (max 16 chars) */
21973
21997
  contactId: string | null;
21974
- /** Web order reference number from the storefront */
21998
+ /** Web order reference number from the storefront (max 255 chars) */
21975
21999
  webReferenceNo: string | null;
21976
22000
  /**
21977
22001
  * PENDING, SUBMITTED, IN PROCESS, ON HOLD or SHIPPED, derived from the completed, approved,
21978
22002
  * cancel and validation flags
21979
22003
  */
21980
22004
  orderStatus: string;
21981
- /** User who entered the order */
22005
+ /** User who entered the order (max 30 chars) */
21982
22006
  taker: string | null;
21983
22007
  /** First name of the ordering contact; null when the order has no contact */
21984
22008
  contactFirstName: string | null;
@@ -22063,7 +22087,7 @@ interface PickTicketsLinesListItem {
22063
22087
  pickTicketNo: number;
22064
22088
  /** Line number on the pick ticket */
22065
22089
  lineNumber: number;
22066
- /** Prophet 21 company */
22090
+ /** Prophet 21 company (max 8 chars) */
22067
22091
  companyId: string;
22068
22092
  /** Quantity printed on the pick ticket */
22069
22093
  printQuantity: number | null;
@@ -22073,7 +22097,7 @@ interface PickTicketsLinesListItem {
22073
22097
  dateCreated: string;
22074
22098
  /** When the line last changed (Y-m-d H:i:s) */
22075
22099
  dateLastModified: string;
22076
- /** Unit of measure the line is picked in */
22100
+ /** Unit of measure the line is picked in (max 8 chars) */
22077
22101
  unitOfMeasure: string;
22078
22102
  /** Base units per unit of measure */
22079
22103
  unitSize: number;
@@ -22091,7 +22115,7 @@ interface PickTicketsLinesListItem {
22091
22115
  invoiceLineUid: number | null;
22092
22116
  /** Quantity scanned while picking */
22093
22117
  qtyScanned: number | null;
22094
- /** Box the line was packed in */
22118
+ /** Box the line was packed in (max 255 chars) */
22095
22119
  boxNumber: string | null;
22096
22120
  /** Quantity to pick when the pick ticket was created */
22097
22121
  originalQtyToPick: number | null;
@@ -22170,7 +22194,7 @@ interface PoHdrListItemLinesItem {
22170
22194
  interface PoHdrListItem {
22171
22195
  /** Purchase order header ID */
22172
22196
  poHdrUid: number;
22173
- /** Y when the purchase order is complete */
22197
+ /** Y when the purchase order is complete (max 1 chars) */
22174
22198
  complete: string | null;
22175
22199
  /** Prophet 21 purchase order number */
22176
22200
  poNo: number;
@@ -22186,15 +22210,15 @@ interface PoHdrListItem {
22186
22210
  divisionId: number | null;
22187
22211
  /** When the purchase order was placed */
22188
22212
  orderDate: PoHdrListItemOrderDate | null;
22189
- /** Prophet 21 company */
22213
+ /** Prophet 21 company (max 8 chars) */
22190
22214
  companyNo: string;
22191
- /** Ship-to name */
22215
+ /** Ship-to name (max 50 chars) */
22192
22216
  ship2Name: string | null;
22193
- /** Vendor packing slip number */
22217
+ /** Vendor packing slip number (max 50 chars) */
22194
22218
  packingSlipNumber: string | null;
22195
- /** Ship-to address line 1 */
22219
+ /** Ship-to address line 1 (max 50 chars) */
22196
22220
  ship2Add1: string | null;
22197
- /** Ship-to address line 2 */
22221
+ /** Ship-to address line 2 (max 50 chars) */
22198
22222
  ship2Add2: string | null;
22199
22223
  /** Prophet 21 location receiving the purchase order */
22200
22224
  locationId: number;
@@ -22415,7 +22439,7 @@ interface OrdersClientSpec {
22415
22439
  * @param params InvoiceHdrReprintListParams (query string)
22416
22440
  * @returns BaseResponse whose `data` is InvoiceHdrReprintListData
22417
22441
  */
22418
- list: (invoiceNo: number, params?: InvoiceHdrReprintListParams) => Promise<BaseResponse$1<InvoiceHdrReprintListData>>;
22442
+ list: (invoiceNo: string, params?: InvoiceHdrReprintListParams) => Promise<BaseResponse$1<InvoiceHdrReprintListData>>;
22419
22443
  };
22420
22444
  };
22421
22445
  oeHdr: {
@@ -23086,7 +23110,7 @@ interface InvMastTextListItem {
23086
23110
  invMastUid: number;
23087
23111
  /** Display order among the item texts */
23088
23112
  sequenceNo: number;
23089
- /** The text (max 2147483647 chars) */
23113
+ /** The text */
23090
23114
  textValue: string;
23091
23115
  /** Y to show the text on the web (max 1 chars) */
23092
23116
  displayOnWebFlag: string;
@@ -23222,7 +23246,7 @@ interface PodcastsListItem {
23222
23246
  title: string | null;
23223
23247
  /** Path of the audio file (max 255 chars) */
23224
23248
  path: string | null;
23225
- /** Podcast transcript (max 2147483647 chars) */
23249
+ /** Podcast transcript */
23226
23250
  transcript: string;
23227
23251
  /** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
23228
23252
  dateCreated: string;
@@ -25619,7 +25643,7 @@ interface RubricsListItem {
25619
25643
  title: string | null;
25620
25644
  /** Rubric id (slug) callers look the rubric up by (max 255 chars) */
25621
25645
  id: string | null;
25622
- /** Prompt template text (max 4294967295 chars) */
25646
+ /** Prompt template text */
25623
25647
  content: string | null;
25624
25648
  /** Update code (1185 = Import Complete) */
25625
25649
  updateCd: number;
@@ -25771,7 +25795,11 @@ interface SitesP21ApiCreateDataP21 {
25771
25795
  password: string;
25772
25796
  /** P21 consumer key for the token endpoint; null while sites use user credentials */
25773
25797
  clientSecret: string | null;
25774
- /** True when the site allows write-back through the P21 API; false until write-back exists */
25798
+ /**
25799
+ * True when the site allows write-back through the P21 API: always true here, since this block
25800
+ * exists only when the site has P21 API credentials; the P21 user's permissions decide what a
25801
+ * write may do
25802
+ */
25775
25803
  writable: boolean;
25776
25804
  [key: string]: unknown;
25777
25805
  }
@@ -25907,11 +25935,11 @@ interface WorkflowsListItem {
25907
25935
  workflowsId: string;
25908
25936
  /** Workflow title (max 255 chars) */
25909
25937
  title: string;
25910
- /** Workflow description (max 4294967295 chars) */
25938
+ /** Workflow description */
25911
25939
  description: string | null;
25912
25940
  /** Services the workflow covers (max 255 chars) */
25913
25941
  services: string;
25914
- /** Workflow content (max 4294967295 chars) */
25942
+ /** Workflow content */
25915
25943
  workflow: string;
25916
25944
  /** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
25917
25945
  dateCreated: string;
@@ -29700,9 +29728,9 @@ type ShippingMethodsUpdateData = ShippingMethodsListItem;
29700
29728
  * Request body of: api.logistics.shippingMethods.update(shippingMethodsUid, data)
29701
29729
  */
29702
29730
  interface ShippingMethodsUpdateBody {
29703
- /** Web display name for the carrier; "" or null clears it */
29731
+ /** Web display name for the carrier; "" or null clears it (max 255 chars) */
29704
29732
  nickname?: string | null;
29705
- /** Shipping type label; "" or null clears it */
29733
+ /** Shipping type label; "" or null clears it (max 255 chars) */
29706
29734
  shippingType?: string | null;
29707
29735
  /** Flat handling fee added to the rate; "" or null clears it */
29708
29736
  handlingFee?: number | null;
@@ -29751,11 +29779,12 @@ interface ShippingMethodsUpdateBody {
29751
29779
  sequenceNo?: number | null;
29752
29780
  /**
29753
29781
  * How the storefront prices the carrier at checkout (ups, fedex, ltl, free); "" or null clears it
29782
+ * (max 16 chars)
29754
29783
  */
29755
29784
  rateSource?: string | null;
29756
29785
  /**
29757
29786
  * Carrier service code (UPS 03, FedEx FEDEX_GROUND), sent as a string to keep leading zeros; ""
29758
- * or null clears it
29787
+ * or null clears it (max 64 chars)
29759
29788
  */
29760
29789
  serviceCode?: string | null;
29761
29790
  [key: string]: unknown;
@@ -30317,7 +30346,7 @@ interface P21ApisClientSpec {
30317
30346
  * @param params TransPurchaseOrderReceiptGetParams (query string)
30318
30347
  * @returns BaseResponse whose `data` is untyped upstream (any JSON value; check before use)
30319
30348
  */
30320
- get: (poNo: string, params?: TransPurchaseOrderReceiptGetParams) => Promise<BaseResponse$1<Record<string, unknown>>>;
30349
+ get: (poNo: number, params?: TransPurchaseOrderReceiptGetParams) => Promise<BaseResponse$1<Record<string, unknown>>>;
30321
30350
  };
30322
30351
  transUser: {
30323
30352
  /**
@@ -30675,33 +30704,33 @@ interface PaymentTypesListParams extends EdgeCacheParams {
30675
30704
  interface AddressListItem {
30676
30705
  /** Prophet 21 address ID */
30677
30706
  id: number;
30678
- /** Address name */
30707
+ /** Address name (max 50 chars) */
30679
30708
  name: string;
30680
- /** Mailing address line 1 */
30709
+ /** Mailing address line 1 (max 50 chars) */
30681
30710
  mailAddress1: string | null;
30682
- /** Mailing address line 2 */
30711
+ /** Mailing address line 2 (max 50 chars) */
30683
30712
  mailAddress2: string | null;
30684
- /** Mailing city */
30713
+ /** Mailing city (max 50 chars) */
30685
30714
  mailCity: string | null;
30686
- /** Mailing state or province */
30715
+ /** Mailing state or province (max 50 chars) */
30687
30716
  mailState: string | null;
30688
- /** Mailing postal code */
30717
+ /** Mailing postal code (max 10 chars) */
30689
30718
  mailPostalCode: string | null;
30690
- /** Mailing country */
30719
+ /** Mailing country (max 50 chars) */
30691
30720
  mailCountry: string | null;
30692
- /** Physical address line 1 */
30721
+ /** Physical address line 1 (max 50 chars) */
30693
30722
  physAddress1: string | null;
30694
- /** Physical address line 2 */
30723
+ /** Physical address line 2 (max 50 chars) */
30695
30724
  physAddress2: string | null;
30696
- /** Physical city */
30725
+ /** Physical city (max 50 chars) */
30697
30726
  physCity: string | null;
30698
- /** Physical state or province */
30727
+ /** Physical state or province (max 50 chars) */
30699
30728
  physState: string | null;
30700
- /** Physical postal code */
30729
+ /** Physical postal code (max 10 chars) */
30701
30730
  physPostalCode: string | null;
30702
- /** Physical country */
30731
+ /** Physical country (max 50 chars) */
30703
30732
  physCountry: string | null;
30704
- /** Y when the address is a carrier */
30733
+ /** Y when the address is a carrier (max 1 chars) */
30705
30734
  carrierFlag: string | null;
30706
30735
  /** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
30707
30736
  statusCd: number;
@@ -31003,39 +31032,39 @@ type FreightCodeGetData = FreightCodeListItem;
31003
31032
  interface LocationListItem {
31004
31033
  /** Prophet 21 location ID (also its address ID) */
31005
31034
  locationId: number;
31006
- /** Prophet 21 company */
31035
+ /** Prophet 21 company (max 8 chars) */
31007
31036
  companyId: string;
31008
- /** Default branch for the location */
31037
+ /** Default branch for the location (max 8 chars) */
31009
31038
  defaultBranchId: string | null;
31010
- /** Y when the location is deleted in Prophet 21 */
31039
+ /** Y when the location is deleted in Prophet 21 (max 1 chars) */
31011
31040
  deleteFlag: string;
31012
31041
  /** When the record was created (Y-m-d H:i:s) */
31013
31042
  dateCreated: string;
31014
31043
  /** When the record last changed (Y-m-d H:i:s) */
31015
31044
  dateLastModified: string;
31016
- /** Prophet 21 user who last changed the record */
31045
+ /** Prophet 21 user who last changed the record (max 30 chars) */
31017
31046
  lastMaintainedBy: string;
31018
- /** Location name */
31047
+ /** Location name (max 255 chars) */
31019
31048
  locationName: string | null;
31020
- /** Y when lots are tracked by bin at the location */
31049
+ /** Y when lots are tracked by bin at the location (max 1 chars) */
31021
31050
  lotBinIntegration: string | null;
31022
- /** FedEx account number for the location */
31051
+ /** FedEx account number for the location (max 255 chars) */
31023
31052
  fedexLocAcctNo: string | null;
31024
- /** FedEx meter number for the location */
31053
+ /** FedEx meter number for the location (max 255 chars) */
31025
31054
  fedexMeterNo: string | null;
31026
- /** UPS account number for the location */
31055
+ /** UPS account number for the location (max 255 chars) */
31027
31056
  upsAccountNo: string | null;
31028
31057
  /** Prophet 21 code for the UPS pickup type */
31029
31058
  upsPickupTypeCd: number | null;
31030
31059
  /** Prophet 21 code for the UPS customer type */
31031
31060
  upsCustomerTypeCd: number | null;
31032
- /** UPS OnLine Tools access key, as Prophet 21 stores it */
31061
+ /** UPS OnLine Tools access key, as Prophet 21 stores it (max 255 chars) */
31033
31062
  upsOltAccessKey: string | null;
31034
- /** UPS OnLine Tools password, as Prophet 21 stores it */
31063
+ /** UPS OnLine Tools password, as Prophet 21 stores it (max 255 chars) */
31035
31064
  upsOltPassword: string | null;
31036
- /** UPS OnLine Tools user ID, as Prophet 21 stores it */
31065
+ /** UPS OnLine Tools user ID, as Prophet 21 stores it (max 255 chars) */
31037
31066
  upsOltUserId: string | null;
31038
- /** Y when the location is a distribution center */
31067
+ /** Y when the location is a distribution center (max 1 chars) */
31039
31068
  distributionCenter: string;
31040
31069
  /** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
31041
31070
  updateCd: number;
@@ -31061,13 +31090,13 @@ type LocationGetData = LocationListItem;
31061
31090
  interface PaymentTypesListItem {
31062
31091
  /** Prophet 21 payment type ID */
31063
31092
  paymentTypeId: number;
31064
- /** Payment type description */
31093
+ /** Payment type description (max 30 chars) */
31065
31094
  paymentTypeDesc: string;
31066
- /** Prophet 21 company */
31095
+ /** Prophet 21 company (max 8 chars) */
31067
31096
  companyId: string;
31068
- /** Prophet 21 payment method the type belongs to */
31097
+ /** Prophet 21 payment method the type belongs to (max 2 chars) */
31069
31098
  paymentMethodId: string;
31070
- /** Y when the payment type is deleted in Prophet 21 */
31099
+ /** Y when the payment type is deleted in Prophet 21 (max 1 chars) */
31071
31100
  deleteFlag: string;
31072
31101
  [key: string]: unknown;
31073
31102
  }
@@ -31601,11 +31630,11 @@ interface ImportListItem {
31601
31630
  * chars)
31602
31631
  */
31603
31632
  importState: string;
31604
- /** Order payload as a JSON string, stored and returned as-is (max 16777215 chars) */
31633
+ /** Order payload as a JSON string, stored and returned as-is */
31605
31634
  jsonData: string | null;
31606
31635
  /** Import status code: 704 = pending, 1185 = Import Complete */
31607
31636
  importStatusCd: number;
31608
- /** Free-text result or failure cause recorded by the pipeline (max 16777215 chars) */
31637
+ /** Free-text result or failure cause recorded by the pipeline */
31609
31638
  importResults: string | null;
31610
31639
  /** Prophet 21 reference once imported, usually the order number (max 255 chars) */
31611
31640
  referenceNo: string | null;
@@ -31911,9 +31940,9 @@ interface ImportImpOeHdrListData {
31911
31940
  orderType830: number | null;
31912
31941
  /** Ship-to address line 3 (max 50 chars) */
31913
31942
  shipToAddress3: string | null;
31914
- /** Extra import properties, stored and returned as text (max 16777215 chars) */
31943
+ /** Extra import properties, stored and returned as text */
31915
31944
  properties: string | null;
31916
- /** Prophet 21 user-defined fields, stored and returned as text (max 16777215 chars) */
31945
+ /** Prophet 21 user-defined fields, stored and returned as text */
31917
31946
  userDefined: string | null;
31918
31947
  [key: string]: unknown;
31919
31948
  }
@@ -31933,15 +31962,15 @@ type ImportImpOeHdrUpdateData = ImportImpOeHdrListData;
31933
31962
  interface ImportImpOeHdrUpdateBody {
31934
31963
  /** Prophet 21 customer the order is for */
31935
31964
  customerId?: number | null;
31936
- /** Prophet 21 contact on the order */
31965
+ /** Prophet 21 contact on the order (max 16 chars) */
31937
31966
  contactId?: string | null;
31938
- /** Prophet 21 company the order belongs to */
31967
+ /** Prophet 21 company the order belongs to (max 8 chars) */
31939
31968
  companyId?: string | null;
31940
31969
  /** Prophet 21 ship-to address the order ships to */
31941
31970
  shipToId?: number | null;
31942
- /** Customer purchase order number */
31971
+ /** Customer purchase order number (max 50 chars) */
31943
31972
  customerPoNo?: string | null;
31944
- /** Customer contract number */
31973
+ /** Customer contract number (max 255 chars) */
31945
31974
  contractNumber?: string | null;
31946
31975
  /** Prophet 21 sales location for the order */
31947
31976
  salesLocationId?: number | null;
@@ -31974,9 +32003,9 @@ interface ImportImpOeHdrSalesrepListData {
31974
32003
  commissionSplit: number | null;
31975
32004
  /** Y when the salesrep receives full commission (max 1 chars) */
31976
32005
  fullCommission: string | null;
31977
- /** Extra import properties, stored and returned as text (max 16777215 chars) */
32006
+ /** Extra import properties, stored and returned as text */
31978
32007
  properties: string | null;
31979
- /** Prophet 21 user-defined fields, stored and returned as text (max 16777215 chars) */
32008
+ /** Prophet 21 user-defined fields, stored and returned as text */
31980
32009
  userDefined: string | null;
31981
32010
  [key: string]: unknown;
31982
32011
  }
@@ -31996,19 +32025,19 @@ type ImportImpOeHdrSalesrepUpdateData = ImportImpOeHdrSalesrepListData;
31996
32025
  * Request body of: api.p21Sism.import.impOeHdrSalesrep.update(importUid, data)
31997
32026
  */
31998
32027
  interface ImportImpOeHdrSalesrepUpdateBody {
31999
- /** Prophet 21 salesrep ID */
32028
+ /** Prophet 21 salesrep ID (max 16 chars) */
32000
32029
  salesrepId?: string | null;
32001
- /** Salesrep first name */
32030
+ /** Salesrep first name (max 15 chars) */
32002
32031
  salesrepFirstName?: string | null;
32003
- /** Salesrep middle initial */
32032
+ /** Salesrep middle initial (max 2 chars) */
32004
32033
  salesrepMi?: string | null;
32005
- /** Salesrep last name */
32034
+ /** Salesrep last name (max 24 chars) */
32006
32035
  salesrepLastName?: string | null;
32007
- /** Y when this is the primary salesrep on the order */
32036
+ /** Y when this is the primary salesrep on the order (max 1 chars) */
32008
32037
  primarySalesrep?: string | null;
32009
32038
  /** Percentage of the commission this salesrep receives */
32010
32039
  commissionSplit?: number | null;
32011
- /** Y when the salesrep receives full commission */
32040
+ /** Y when the salesrep receives full commission (max 1 chars) */
32012
32041
  fullCommission?: string | null;
32013
32042
  [key: string]: unknown;
32014
32043
  }
@@ -32035,9 +32064,9 @@ interface ImportImpOeHdrWebListData {
32035
32064
  unknown3: string | null;
32036
32065
  /** Unnamed field 4 of the Prophet 21 order web-header import layout (max 255 chars) */
32037
32066
  unknown4: string | null;
32038
- /** Extra import properties, stored and returned as text (max 16777215 chars) */
32067
+ /** Extra import properties, stored and returned as text */
32039
32068
  properties: string | null;
32040
- /** Prophet 21 user-defined fields, stored and returned as text (max 16777215 chars) */
32069
+ /** Prophet 21 user-defined fields, stored and returned as text */
32041
32070
  userDefined: string | null;
32042
32071
  /** When the row was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
32043
32072
  dateCreated: string;
@@ -32120,7 +32149,7 @@ interface ScheduledImportMasterMetadataCreateData {
32120
32149
  deliveryMethod: string;
32121
32150
  /**
32122
32151
  * FTP/SFTP connection as a JSON string (host, port, username, password, path); pending_import
32123
- * does not read it (max 16777215 chars)
32152
+ * does not read it
32124
32153
  */
32125
32154
  properties: string | null;
32126
32155
  /** Date the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
@@ -32275,7 +32304,7 @@ interface P21SismClientSpec {
32275
32304
  * @param params ImportGetParams (query string)
32276
32305
  * @returns BaseResponse whose `data` is ImportGetData
32277
32306
  */
32278
- get: (importUid: string, params?: ImportGetParams) => Promise<BaseResponse$1<ImportGetData>>;
32307
+ get: (importUid: number, params?: ImportGetParams) => Promise<BaseResponse$1<ImportGetData>>;
32279
32308
  /**
32280
32309
  * Update an import
32281
32310
  * Call: api.p21Sism.import.update(importUid, data)
@@ -32293,7 +32322,7 @@ interface P21SismClientSpec {
32293
32322
  * @param data ImportUpdateBody (request body)
32294
32323
  * @returns BaseResponse whose `data` is ImportUpdateData
32295
32324
  */
32296
- update: (importUid: string, data: ImportUpdateBody) => Promise<BaseResponse$1<ImportUpdateData>>;
32325
+ update: (importUid: number, data: ImportUpdateBody) => Promise<BaseResponse$1<ImportUpdateData>>;
32297
32326
  /**
32298
32327
  * clean pending_import for an import
32299
32328
  * Call: api.p21Sism.import.delete(importUid)
@@ -32310,7 +32339,7 @@ interface P21SismClientSpec {
32310
32339
  * @param importUid import.import_uid
32311
32340
  * @returns BaseResponse whose `data` is ImportDeleteData
32312
32341
  */
32313
- delete: (importUid: string) => Promise<BaseResponse$1<ImportDeleteData>>;
32342
+ delete: (importUid: number) => Promise<BaseResponse$1<ImportDeleteData>>;
32314
32343
  dailySummary: {
32315
32344
  /**
32316
32345
  * Get daily import counts by state
@@ -32342,7 +32371,7 @@ interface P21SismClientSpec {
32342
32371
  * @param params ImportImpOeHdrListParams (query string)
32343
32372
  * @returns BaseResponse whose `data` is ImportImpOeHdrListData
32344
32373
  */
32345
- list: (importUid: string, params?: ImportImpOeHdrListParams) => Promise<BaseResponse$1<ImportImpOeHdrListData>>;
32374
+ list: (importUid: number, params?: ImportImpOeHdrListParams) => Promise<BaseResponse$1<ImportImpOeHdrListData>>;
32346
32375
  /**
32347
32376
  * Update imp_oe_hdr table
32348
32377
  * Call: api.p21Sism.import.impOeHdr.update(importUid, data)
@@ -32361,7 +32390,7 @@ interface P21SismClientSpec {
32361
32390
  * @param data ImportImpOeHdrUpdateBody (request body)
32362
32391
  * @returns BaseResponse whose `data` is ImportImpOeHdrUpdateData
32363
32392
  */
32364
- update: (importUid: string, data: ImportImpOeHdrUpdateBody) => Promise<BaseResponse$1<ImportImpOeHdrUpdateData>>;
32393
+ update: (importUid: number, data: ImportImpOeHdrUpdateBody) => Promise<BaseResponse$1<ImportImpOeHdrUpdateData>>;
32365
32394
  };
32366
32395
  impOeHdrSalesrep: {
32367
32396
  /**
@@ -32379,7 +32408,7 @@ interface P21SismClientSpec {
32379
32408
  * @param params ImportImpOeHdrSalesrepListParams (query string)
32380
32409
  * @returns BaseResponse whose `data` is ImportImpOeHdrSalesrepListData
32381
32410
  */
32382
- list: (importUid: string, params?: ImportImpOeHdrSalesrepListParams) => Promise<BaseResponse$1<ImportImpOeHdrSalesrepListData>>;
32411
+ list: (importUid: number, params?: ImportImpOeHdrSalesrepListParams) => Promise<BaseResponse$1<ImportImpOeHdrSalesrepListData>>;
32383
32412
  /**
32384
32413
  * Update imp_oe_hdr_salesrep table
32385
32414
  * Call: api.p21Sism.import.impOeHdrSalesrep.update(importUid, data)
@@ -32398,7 +32427,7 @@ interface P21SismClientSpec {
32398
32427
  * @param data ImportImpOeHdrSalesrepUpdateBody (request body)
32399
32428
  * @returns BaseResponse whose `data` is ImportImpOeHdrSalesrepUpdateData
32400
32429
  */
32401
- update: (importUid: string, data: ImportImpOeHdrSalesrepUpdateBody) => Promise<BaseResponse$1<ImportImpOeHdrSalesrepUpdateData>>;
32430
+ update: (importUid: number, data: ImportImpOeHdrSalesrepUpdateBody) => Promise<BaseResponse$1<ImportImpOeHdrSalesrepUpdateData>>;
32402
32431
  };
32403
32432
  impOeHdrWeb: {
32404
32433
  /**
@@ -32416,7 +32445,7 @@ interface P21SismClientSpec {
32416
32445
  * @param params ImportImpOeHdrWebListParams (query string)
32417
32446
  * @returns BaseResponse whose `data` is ImportImpOeHdrWebListData
32418
32447
  */
32419
- list: (importUid: string, params?: ImportImpOeHdrWebListParams) => Promise<BaseResponse$1<ImportImpOeHdrWebListData>>;
32448
+ list: (importUid: number, params?: ImportImpOeHdrWebListParams) => Promise<BaseResponse$1<ImportImpOeHdrWebListData>>;
32420
32449
  };
32421
32450
  recent: {
32422
32451
  /**
@@ -32489,7 +32518,7 @@ interface P21SismClientSpec {
32489
32518
  * @param params ScheduledImportMasterGetParams (query string)
32490
32519
  * @returns BaseResponse whose `data` is ScheduledImportMasterGetData
32491
32520
  */
32492
- get: (scheduledImportMasterUid: string, params?: ScheduledImportMasterGetParams) => Promise<BaseResponse$1<ScheduledImportMasterGetData>>;
32521
+ get: (scheduledImportMasterUid: number, params?: ScheduledImportMasterGetParams) => Promise<BaseResponse$1<ScheduledImportMasterGetData>>;
32493
32522
  metadata: {
32494
32523
  /**
32495
32524
  * Set the delivery method of a scheduled import master
@@ -32517,7 +32546,7 @@ interface P21SismClientSpec {
32517
32546
  * @param data ScheduledImportMasterMetadataCreateBody (request body)
32518
32547
  * @returns BaseResponse whose `data` is ScheduledImportMasterMetadataCreateData
32519
32548
  */
32520
- create: (scheduledImportMasterUid: string, data: ScheduledImportMasterMetadataCreateBody) => Promise<BaseResponse$1<ScheduledImportMasterMetadataCreateData>>;
32549
+ create: (scheduledImportMasterUid: number, data: ScheduledImportMasterMetadataCreateBody) => Promise<BaseResponse$1<ScheduledImportMasterMetadataCreateData>>;
32521
32550
  sftp: {
32522
32551
  /**
32523
32552
  * Create SFTP metadata for a scheduled import master
@@ -32541,7 +32570,7 @@ interface P21SismClientSpec {
32541
32570
  * @param data ScheduledImportMasterMetadataSftpCreateBody (request body)
32542
32571
  * @returns BaseResponse whose `data` is ScheduledImportMasterMetadataSftpCreateData
32543
32572
  */
32544
- create: (scheduledImportMasterUid: string, data: ScheduledImportMasterMetadataSftpCreateBody) => Promise<BaseResponse$1<ScheduledImportMasterMetadataSftpCreateData>>;
32573
+ create: (scheduledImportMasterUid: number, data: ScheduledImportMasterMetadataSftpCreateBody) => Promise<BaseResponse$1<ScheduledImportMasterMetadataSftpCreateData>>;
32545
32574
  };
32546
32575
  };
32547
32576
  };
@@ -32580,7 +32609,7 @@ interface P21SismClientSpec {
32580
32609
  * @param params ScheduledImportMetadataGetParams (query string)
32581
32610
  * @returns BaseResponse whose `data` is ScheduledImportMetadataGetData
32582
32611
  */
32583
- get: (scheduledImportMetadataUid: string, params?: ScheduledImportMetadataGetParams) => Promise<BaseResponse$1<ScheduledImportMetadataGetData>>;
32612
+ get: (scheduledImportMetadataUid: number, params?: ScheduledImportMetadataGetParams) => Promise<BaseResponse$1<ScheduledImportMetadataGetData>>;
32584
32613
  /**
32585
32614
  * Change a scheduled import metadata record
32586
32615
  * Call: api.p21Sism.scheduledImportMetadata.update(scheduledImportMetadataUid, data)
@@ -32604,7 +32633,7 @@ interface P21SismClientSpec {
32604
32633
  * @param data ScheduledImportMetadataUpdateBody (request body)
32605
32634
  * @returns BaseResponse whose `data` is ScheduledImportMetadataUpdateData
32606
32635
  */
32607
- update: (scheduledImportMetadataUid: string, data: ScheduledImportMetadataUpdateBody) => Promise<BaseResponse$1<ScheduledImportMetadataUpdateData>>;
32636
+ update: (scheduledImportMetadataUid: number, data: ScheduledImportMetadataUpdateBody) => Promise<BaseResponse$1<ScheduledImportMetadataUpdateData>>;
32608
32637
  /**
32609
32638
  * Soft delete a scheduled import metadata record
32610
32639
  * Call: api.p21Sism.scheduledImportMetadata.delete(scheduledImportMetadataUid)
@@ -32621,7 +32650,7 @@ interface P21SismClientSpec {
32621
32650
  * @param scheduledImportMetadataUid Scheduled import metadata record to soft delete
32622
32651
  * @returns BaseResponse whose `data` is ScheduledImportMetadataDeleteData
32623
32652
  */
32624
- delete: (scheduledImportMetadataUid: string) => Promise<BaseResponse$1<ScheduledImportMetadataDeleteData>>;
32653
+ delete: (scheduledImportMetadataUid: number) => Promise<BaseResponse$1<ScheduledImportMetadataDeleteData>>;
32625
32654
  };
32626
32655
  }
32627
32656
 
@@ -33630,7 +33659,7 @@ type TodosSessionsGetParams = EdgeCacheParams;
33630
33659
  interface CommentsListItem {
33631
33660
  /** Basecamp comment ID */
33632
33661
  id: number;
33633
- /** Comment HTML, or efs:{hash} when the body is stored in EFS (max 65535 chars) */
33662
+ /** Comment HTML, or efs:{hash} when the body is stored in EFS */
33634
33663
  content: string;
33635
33664
  /** When the record was last updated in Basecamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
33636
33665
  updatedAt: string;
@@ -33646,7 +33675,7 @@ interface CommentsListItem {
33646
33675
  processCd: number;
33647
33676
  /** To-do the comment belongs to */
33648
33677
  todosId: number | null;
33649
- /** The 1536 dimensional vector that represents the comment (max 65535 chars) */
33678
+ /** The 1536 dimensional vector that represents the comment */
33650
33679
  vector: string | null;
33651
33680
  /** Embedding queue code (704 = queued, 1185 = done) */
33652
33681
  vectorCd: number;
@@ -33728,7 +33757,7 @@ interface MetricsListItem {
33728
33757
  assigneeId: number | null;
33729
33758
  /** FK to people.id (creator) */
33730
33759
  creatorId: number;
33731
- /** Todos title/content (max 65535 chars) */
33760
+ /** Todos title/content */
33732
33761
  todosContent: string | null;
33733
33762
  /** Status (1=open, 2=completed) */
33734
33763
  todosStatusCd: number;
@@ -34060,7 +34089,7 @@ interface TodosListItem {
34060
34089
  position: number;
34061
34090
  /** Project the to-do belongs to */
34062
34091
  projectsId: number;
34063
- /** Full Basecamp to-do detail as JSON (max 4294967295 chars) */
34092
+ /** Full Basecamp to-do detail as JSON */
34064
34093
  detailJson: string | null;
34065
34094
  /** Detail fetch queue code (704 = queued, 1185 = fetched) */
34066
34095
  pullDetailCd: number;
@@ -34072,7 +34101,7 @@ interface TodosListItem {
34072
34101
  statusCd: number;
34073
34102
  /** When the latest comment was posted (mysql-datetime, e.g. 2025-07-30 15:50:49) */
34074
34103
  lastCommentAt: string;
34075
- /** The 1536 dimensional vector that represents the comment (max 65535 chars) */
34104
+ /** The 1536 dimensional vector that represents the comment */
34076
34105
  vector: string | null;
34077
34106
  /** Comments embedding queue code (704 = queued, 1185 = done) */
34078
34107
  vectorCd: number;
@@ -34094,11 +34123,11 @@ type TodosListData = TodosListItem[];
34094
34123
  interface TodosSummaryListItem {
34095
34124
  /** Primary key - same value as todos.id, enforced in code */
34096
34125
  id: number;
34097
- /** AI-generated summary of ticket and comments (max 65535 chars) */
34126
+ /** AI-generated summary of ticket and comments */
34098
34127
  summary: string | null;
34099
34128
  /** Token estimate for summary size */
34100
34129
  summaryTokens: number;
34101
- /** Full context blob in YAML format for knowledge base (max 4294967295 chars) */
34130
+ /** Full context blob in YAML format for knowledge base */
34102
34131
  context: string | null;
34103
34132
  /** Token estimate for context size */
34104
34133
  contextTokens: number;
@@ -34201,13 +34230,13 @@ interface TodosSessionsListItem {
34201
34230
  sessionStatusCd: number;
34202
34231
  /** Session subject/title (max 255 chars) */
34203
34232
  subject: string | null;
34204
- /** Problem statement (max 65535 chars) */
34233
+ /** Problem statement */
34205
34234
  problem: string | null;
34206
- /** Investigation notes (max 65535 chars) */
34235
+ /** Investigation notes */
34207
34236
  investigation: string | null;
34208
- /** Execution plan (max 65535 chars) */
34237
+ /** Execution plan */
34209
34238
  plan: string | null;
34210
- /** Session outcome/result (max 65535 chars) */
34239
+ /** Session outcome/result */
34211
34240
  outcome: string | null;
34212
34241
  /** Record creation timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
34213
34242
  dateCreated: string;