randmar-api-client 1.576.0 → 1.577.0

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.
@@ -467,39 +467,39 @@ export type PostV4ShopifyByShopifyHostNameAccountSynchronizationAndSynchronizati
467
467
  export type PostV4ShopifyByShopifyHostNameAccountSynchronizationAndSynchronizationTypeApiArg = {
468
468
  /** The host name of the Shopify store. */
469
469
  shopifyHostName: string;
470
- /** The type of synchronization to update (e.g., 'Products', 'Orders'). */
470
+ /** Orders or ProductInventory, producing SyncOrders or SyncProductInventory. Products is not a supported flag. */
471
471
  synchronizationType: string;
472
- /** The new boolean value for the setting (true to enable, false to disable). */
472
+ /** Query boolean: true to enable or false to disable. */
473
473
  newValue?: boolean;
474
474
  };
475
475
  export type PostV4ShopifyByShopifyHostNameAccountAndPropertyNameApiResponse = unknown;
476
476
  export type PostV4ShopifyByShopifyHostNameAccountAndPropertyNameApiArg = {
477
477
  /** The host name of the Shopify store. */
478
478
  shopifyHostName: string;
479
- /** The name of the account property to update. */
479
+ /** SyncOrders, ShipComplete, SyncProductInventory, or DefaultCustomization (case-insensitive). */
480
480
  propertyName: string;
481
- /** The new boolean value for the property. */
481
+ /** Query boolean value for the property. */
482
482
  newValue?: boolean;
483
483
  };
484
484
  export type PostV4ShopifyByShopifyHostNameAccountDefaultShippingSlipCommentApiResponse = unknown;
485
485
  export type PostV4ShopifyByShopifyHostNameAccountDefaultShippingSlipCommentApiArg = {
486
486
  /** The host name of the Shopify store. */
487
487
  shopifyHostName: string;
488
- /** The new default comment string. */
488
+ /** URL-encoded query text for the default shipping-slip comment. */
489
489
  newValue?: string;
490
490
  };
491
491
  export type PostV4ShopifyByShopifyHostNameAccountAdsGrowthStrategyApiResponse = unknown;
492
492
  export type PostV4ShopifyByShopifyHostNameAccountAdsGrowthStrategyApiArg = {
493
493
  /** The host name of the Shopify store. */
494
494
  shopifyHostName: string;
495
- /** The ads growth strategy to store. */
495
+ /** URL-encoded query value using one of the listed strategies; matching is case-insensitive. */
496
496
  newValue?: string;
497
497
  };
498
498
  export type PostV4ShopifyByShopifyHostNameAccountAdvertisingBudgetPerDayApiResponse = unknown;
499
499
  export type PostV4ShopifyByShopifyHostNameAccountAdvertisingBudgetPerDayApiArg = {
500
500
  /** The host name of the Shopify store. */
501
501
  shopifyHostName: string;
502
- /** The daily advertising budget to store. */
502
+ /** Nonnegative decimal budget supplied as a query value. */
503
503
  newValue?: number;
504
504
  };
505
505
  export type PutV4ShopifyByShopifyHostNameAccountLinkApiResponse = unknown;
@@ -529,7 +529,7 @@ export type PostV4PartnerByApplicationIdAccountAndFieldNameApiResponse = unknown
529
529
  export type PostV4PartnerByApplicationIdAccountAndFieldNameApiArg = {
530
530
  /** The partner application ID. Admins must pass the target partner ID, not HQ (`2` / `FGDCT3037`). */
531
531
  applicationId: string;
532
- /** The name of the property to update. */
532
+ /** PublicName, About, VoiceName, VoiceStyle, or SceneName, with exact casing. */
533
533
  fieldName: string;
534
534
  /** The new value for the property. */
535
535
  newValue?: string;
@@ -639,7 +639,9 @@ export type PostV4PartnerByApplicationIdAccountBillingApiArg = {
639
639
  };
640
640
  export type PostV4PartnerByApplicationIdAccountResellerShippingApiResponse = unknown;
641
641
  export type PostV4PartnerByApplicationIdAccountResellerShippingApiArg = {
642
+ /** Target partner application ID. */
642
643
  applicationId: string;
644
+ /** JSON shipping name and complete address: Address1, Address2, City, Province, PostalCode, and Country. */
643
645
  newShippingInformation: NewShippingInformation;
644
646
  };
645
647
  export type PutV4PartnerByApplicationIdAccountSalesAgencyApiResponse = unknown;
@@ -758,9 +760,9 @@ export type DeleteV4PartnerByApplicationIdAccountSocialAndSocialNetworkApiArg =
758
760
  export type GetV4ManufacturerByRouteManufacturerIdAccountApiResponse =
759
761
  /** status 200 The manufacturer's account information. */ Manufacturer;
760
762
  export type GetV4ManufacturerByRouteManufacturerIdAccountApiArg = {
761
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
763
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
762
764
  routeManufacturerId: string;
763
- /** If true, includes detailed specifications in the response. Defaults to true. */
765
+ /** Query parameter. If true, includes detailed specifications in the response. Defaults to true. */
764
766
  withSpecification?: boolean;
765
767
  };
766
768
  export type GetV4PartnerByRouteApplicationIdAdsPlatformsStatusApiResponse =
@@ -782,24 +784,24 @@ export type GetV4AgencyByRouteAgencyIdApiArg = {
782
784
  routeAgencyId: string;
783
785
  };
784
786
  export type PostV4AgencyByRouteAgencyIdResellerSalesEmailApiResponse =
785
- /** status 200 Returns the result of the email delivery request. */ boolean;
787
+ /** status 200 False if no report content was produced; otherwise true after the send was attempted. This is not a delivery receipt. */ boolean;
786
788
  export type PostV4AgencyByRouteAgencyIdResellerSalesEmailApiArg = {
787
789
  /** The target agency application ID. Not HQ IDs such as `2` or `FGDCT3037`. Resolve names via `GET V4/Intranet/Search/Partners`. */
788
790
  routeAgencyId: string;
789
- /** The destination email address that should receive the Excel report. */
791
+ /** Query destination address. An empty value falls back to the authenticated user. */
790
792
  emailAddress?: string;
791
- /** The optional start date of the reporting period. */
793
+ /** Optional query start date in ISO 8601 form; an omitted value is passed to the reporting service's default period. */
792
794
  startDate?: string;
793
- /** The optional end date of the reporting period. */
795
+ /** Optional query end date in ISO 8601 form; an omitted value is passed to the reporting service's default period. */
794
796
  endDate?: string;
795
797
  };
796
798
  export type PostV4AgencyByRouteAgencyIdResellerSalesFileApiResponse = unknown;
797
799
  export type PostV4AgencyByRouteAgencyIdResellerSalesFileApiArg = {
798
800
  /** The target agency application ID. Not HQ IDs such as `2` or `FGDCT3037`. Resolve names via `GET V4/Intranet/Search/Partners`. */
799
801
  routeAgencyId: string;
800
- /** The optional start date of the reporting period. */
802
+ /** Optional query start date in ISO 8601 form; omitted values use the reporting service's default period. */
801
803
  startDate?: string;
802
- /** The optional end date of the reporting period. */
804
+ /** Optional query end date in ISO 8601 form; omitted values use the reporting service's default period. */
803
805
  endDate?: string;
804
806
  };
805
807
  export type PostV4PartnerByApplicationIdAttachmentUploadApiResponse =
@@ -1057,7 +1059,7 @@ export type PostV4ResellerByRouteResellerIdCartProcessAndCartNameApiArg = {
1057
1059
  shipToLocation: ShipToLocation;
1058
1060
  };
1059
1061
  export type PostV4ResellerByRouteResellerIdCartProcessNewAndCartNameApiResponse =
1060
- /** status 200 Returns an object that contains the OrderID that was created. If this fails, make sure items are in stock and have a bid number (when needed). */ ProcessOrderNewResponse;
1062
+ /** status 200 Returns an object with OrderNumber. The source cart is deleted after order creation. Custom shipping-slip failures are recorded as order comments, not returned as warnings or used to roll back the order. */ ProcessOrderNewResponse;
1061
1063
  export type PostV4ResellerByRouteResellerIdCartProcessNewAndCartNameApiArg = {
1062
1064
  /** The target reseller application ID. */
1063
1065
  routeResellerId: string;
@@ -1080,115 +1082,115 @@ export type DeleteV4ResellerByRouteResellerIdCartsApiArg = {
1080
1082
  export type GetV4ManufacturerByRouteManufacturerIdCategoriesApiResponse =
1081
1083
  /** status 200 A list of manufacturer categories. */ ManufacturerCategory[];
1082
1084
  export type GetV4ManufacturerByRouteManufacturerIdCategoriesApiArg = {
1083
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1085
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1084
1086
  routeManufacturerId: string;
1085
1087
  };
1086
1088
  export type GetV4ManufacturerByRouteManufacturerIdCategoriesNichesApiResponse =
1087
1089
  /** status 200 A list of product niches. */ ProductNiche[];
1088
1090
  export type GetV4ManufacturerByRouteManufacturerIdCategoriesNichesApiArg = {
1089
- /** The target manufacturer's application ID (authorization only). Admins must pass the manufacturer ID, not HQ. */
1091
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1090
1092
  routeManufacturerId: string;
1091
1093
  };
1092
1094
  export type GetV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeApiResponse =
1093
1095
  /** status 200 The requested category's information. */ ManufacturerCategory;
1094
1096
  export type GetV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeApiArg = {
1095
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1097
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1096
1098
  routeManufacturerId: string;
1097
- /** The category code. Resolve from `GET .../Categories` if the user gave a name. */
1099
+ /** Path parameter. The category code. Resolve from `GET .../Categories` if the user gave a name. */
1098
1100
  categoryCode: string;
1099
1101
  };
1100
1102
  export type PutV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeApiResponse = unknown;
1101
1103
  export type PutV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeApiArg = {
1102
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1104
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1103
1105
  routeManufacturerId: string;
1104
- /** The code for the new category (unique for this manufacturer). */
1106
+ /** Path parameter. The code for the new category (unique for this manufacturer). */
1105
1107
  categoryCode: string;
1106
1108
  };
1107
1109
  export type DeleteV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeApiResponse = unknown;
1108
1110
  export type DeleteV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeApiArg = {
1109
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1111
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1110
1112
  routeManufacturerId: string;
1111
- /** The category code to delete. Resolve from `GET .../Categories`. */
1113
+ /** Path parameter. The category code to delete. Resolve from `GET .../Categories`. */
1112
1114
  categoryCode: string;
1113
1115
  };
1114
1116
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeFieldNameApiResponse = unknown;
1115
1117
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeFieldNameApiArg = {
1116
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1118
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1117
1119
  routeManufacturerId: string;
1118
- /** The category code to update. Resolve from `GET .../Categories`. */
1120
+ /** Path parameter. The category code to update. Resolve from `GET .../Categories`. */
1119
1121
  categoryCode: string;
1120
- /** Field to update: "WeeksOfStocking", "CategoryName", "Starred", "AutoReorder", "QualificationRequired", or "Niche". Case-sensitive; use the name from the category JSON. */
1122
+ /** Path parameter. Field to update: "WeeksOfStocking", "CategoryName", "Starred", "AutoReorder", "QualificationRequired", or "Niche". Case-sensitive; use the name from the category JSON. */
1121
1123
  fieldName: string;
1122
- /** The new value for the field. */
1124
+ /** Query parameter. The new value for the field. */
1123
1125
  newValue?: string;
1124
1126
  };
1125
1127
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeAGpApiResponse = unknown;
1126
1128
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeAGpApiArg = {
1127
- /** The application ID of the Manufacturer making the request. */
1129
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1128
1130
  routeManufacturerId: string;
1129
- /** The code of the category to update. */
1131
+ /** Path parameter. The code of the category to update. */
1130
1132
  categoryCode: string;
1131
- /** The new margin percentage. */
1133
+ /** Query parameter. New margin value from 0 through 250 inclusive. */
1132
1134
  newValue?: number;
1133
1135
  };
1134
1136
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeBGpApiResponse = unknown;
1135
1137
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeBGpApiArg = {
1136
- /** The application ID of the Manufacturer making the request. */
1138
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1137
1139
  routeManufacturerId: string;
1138
- /** The code of the category to update. */
1140
+ /** Path parameter. The code of the category to update. */
1139
1141
  categoryCode: string;
1140
- /** The new margin percentage. */
1142
+ /** Query parameter. New margin value from 0 through 250 inclusive. */
1141
1143
  newValue?: number;
1142
1144
  };
1143
1145
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeCGpApiResponse = unknown;
1144
1146
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeCGpApiArg = {
1145
- /** The application ID of the Manufacturer making the request. */
1147
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1146
1148
  routeManufacturerId: string;
1147
- /** The code of the category to update. */
1149
+ /** Path parameter. The code of the category to update. */
1148
1150
  categoryCode: string;
1149
- /** The new margin percentage. */
1151
+ /** Query parameter. New margin value from 0 through 250 inclusive. */
1150
1152
  newValue?: number;
1151
1153
  };
1152
1154
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeDGpApiResponse = unknown;
1153
1155
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeDGpApiArg = {
1154
- /** The application ID of the Manufacturer making the request. */
1156
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1155
1157
  routeManufacturerId: string;
1156
- /** The code of the category to update. */
1158
+ /** Path parameter. The code of the category to update. */
1157
1159
  categoryCode: string;
1158
- /** The new margin percentage. */
1160
+ /** Query parameter. New margin value from 0 through 250 inclusive. */
1159
1161
  newValue?: number;
1160
1162
  };
1161
1163
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeCostGpApiResponse = unknown;
1162
1164
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeCostGpApiArg = {
1163
- /** The application ID of the Manufacturer making the request. */
1165
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1164
1166
  routeManufacturerId: string;
1165
- /** The code of the category to update. */
1167
+ /** Path parameter. The code of the category to update. */
1166
1168
  categoryCode: string;
1167
- /** The new margin percentage. */
1169
+ /** Query parameter. New margin value from 0 through 250 inclusive. */
1168
1170
  newValue?: number;
1169
1171
  };
1170
1172
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeResetApiResponse = unknown;
1171
1173
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeResetApiArg = {
1172
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1174
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1173
1175
  routeManufacturerId: string;
1174
- /** The category code to reset. Resolve from `GET .../Categories`. */
1176
+ /** Path parameter. The category code to reset. Resolve from `GET .../Categories`. */
1175
1177
  categoryCode: string;
1176
1178
  };
1177
1179
  export type PutV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeStarredApiResponse = unknown;
1178
1180
  export type PutV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeStarredApiArg = {
1179
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1181
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1180
1182
  routeManufacturerId: string;
1181
- /** The category code to star or un-star. */
1183
+ /** Path parameter. The category code to star or un-star. */
1182
1184
  categoryCode: string;
1183
1185
  };
1184
1186
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeImageApiResponse = unknown;
1185
1187
  export type PostV4ManufacturerByRouteManufacturerIdCategoryAndCategoryCodeImageApiArg = {
1186
- /** The application ID of the Manufacturer making the request. */
1188
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1187
1189
  routeManufacturerId: string;
1188
- /** The code of the category to update. */
1190
+ /** Path parameter. The code of the category to update. */
1189
1191
  categoryCode: string;
1190
1192
  body: {
1191
- /** The image file to upload. */
1193
+ /** Multipart form field. The image file to upload. */
1192
1194
  file?: Blob;
1193
1195
  };
1194
1196
  };
@@ -1299,44 +1301,44 @@ export type GetV4PartnerByApplicationIdDocumentAndDocumentNumberPdfApiArg = {
1299
1301
  };
1300
1302
  export type GetV4ManufacturerByRouteManufacturerIdDocumentAndDocumentNumberApiResponse = unknown;
1301
1303
  export type GetV4ManufacturerByRouteManufacturerIdDocumentAndDocumentNumberApiArg = {
1302
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1304
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1303
1305
  routeManufacturerId: string;
1304
- /** The document number (typically starts with PO, RCP, or RQN). Resolve from Documents lists if unknown. */
1306
+ /** Path parameter. The document number (typically starts with PO, RCP, or RQN). Resolve from Documents lists if unknown. */
1305
1307
  documentNumber: string;
1306
1308
  };
1307
1309
  export type GetV4ManufacturerByRouteManufacturerIdDocumentAndDocumentNumberPdfApiResponse = unknown;
1308
1310
  export type GetV4ManufacturerByRouteManufacturerIdDocumentAndDocumentNumberPdfApiArg = {
1309
- /** The application ID of the Manufacturer making the request. */
1311
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1310
1312
  routeManufacturerId: string;
1311
- /** The unique number of the document to retrieve as a PDF. */
1313
+ /** Path parameter. The unique number of the document to retrieve as a PDF. */
1312
1314
  documentNumber: string;
1313
1315
  };
1314
1316
  export type PostV4ManufacturerByRouteManufacturerIdDocumentAndDocumentNumberEmailApiResponse = unknown;
1315
1317
  export type PostV4ManufacturerByRouteManufacturerIdDocumentAndDocumentNumberEmailApiArg = {
1316
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1318
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1317
1319
  routeManufacturerId: string;
1318
- /** The document number to send (PO, RCP, or RQN). */
1320
+ /** Path parameter. The document number to send (PO, RCP, or RQN). */
1319
1321
  documentNumber: string;
1320
- /** The recipient email address. Confirm with the user; do not guess. */
1322
+ /** Query parameter. The recipient email address. Confirm with the user; do not guess. */
1321
1323
  emailAddress?: string;
1322
- /** Optional comment included in the email body. */
1324
+ /** Query parameter. Optional comment included in the email body. */
1323
1325
  comment?: string;
1324
1326
  };
1325
1327
  export type PutV4ManufacturerByRouteManufacturerIdDocumentSalesOrderAndOrderNumberExecuteApiResponse = unknown;
1326
1328
  export type PutV4ManufacturerByRouteManufacturerIdDocumentSalesOrderAndOrderNumberExecuteApiArg = {
1327
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1329
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1328
1330
  routeManufacturerId: string;
1329
- /** The sales order number to execute. Resolve from ActiveOrderDetails if unknown. */
1331
+ /** Path parameter. The sales order number to execute. Resolve from ActiveOrderDetails if unknown. */
1330
1332
  orderNumber: string;
1331
1333
  };
1332
1334
  export type GetV4ManufacturerByRouteManufacturerIdDocumentSalesOrderAndOrderNumberApiResponse =
1333
1335
  /** status 200 The requested sales order's data. */ Order;
1334
1336
  export type GetV4ManufacturerByRouteManufacturerIdDocumentSalesOrderAndOrderNumberApiArg = {
1335
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1337
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1336
1338
  routeManufacturerId: string;
1337
- /** The sales order number. Resolve from ActiveOrderDetails or CompletedOrderDetails if unknown. */
1339
+ /** Path parameter. The sales order number. Resolve from ActiveOrderDetails or CompletedOrderDetails if unknown. */
1338
1340
  orderNumber: string;
1339
- /** Whether to include detailed product specifications in the response. */
1341
+ /** Query parameter. Defaults to true. False additionally loads ActiveOrderDetails and CompletedSalesOrderDetails; this flag does not request product specifications in this service. */
1340
1342
  withSpecification?: boolean;
1341
1343
  };
1342
1344
  export type GetV4ResellerByRouteResellerIdDocumentsActiveOrderDetailsApiResponse =
@@ -1354,84 +1356,85 @@ export type GetV4ResellerByRouteResellerIdDocumentsGeneralDocumentsApiArg = {
1354
1356
  export type GetV4ManufacturerByRouteManufacturerIdDocumentsRequisitionsApiResponse =
1355
1357
  /** status 200 A list of requisitions. */ Requisition[];
1356
1358
  export type GetV4ManufacturerByRouteManufacturerIdDocumentsRequisitionsApiArg = {
1357
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1359
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1358
1360
  routeManufacturerId: string;
1359
1361
  };
1360
1362
  export type GetV4ManufacturerByRouteManufacturerIdDocumentRequisitionsApiResponse =
1361
1363
  /** status 200 A list of requisitions. */ Requisition[];
1362
1364
  export type GetV4ManufacturerByRouteManufacturerIdDocumentRequisitionsApiArg = {
1363
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1365
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1364
1366
  routeManufacturerId: string;
1365
1367
  };
1366
1368
  export type GetV4ManufacturerByRouteManufacturerIdDocumentsPurchaseOrdersApiResponse =
1367
1369
  /** status 200 A list of purchase orders. */ PurchaseOrder[];
1368
1370
  export type GetV4ManufacturerByRouteManufacturerIdDocumentsPurchaseOrdersApiArg = {
1369
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1371
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1370
1372
  routeManufacturerId: string;
1371
1373
  };
1372
1374
  export type GetV4ManufacturerByRouteManufacturerIdDocumentPurchaseOrdersApiResponse =
1373
1375
  /** status 200 A list of purchase orders. */ PurchaseOrder[];
1374
1376
  export type GetV4ManufacturerByRouteManufacturerIdDocumentPurchaseOrdersApiArg = {
1375
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1377
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1376
1378
  routeManufacturerId: string;
1377
1379
  };
1378
1380
  export type GetV4ManufacturerByRouteManufacturerIdDocumentsReceiptsApiResponse =
1379
1381
  /** status 200 A list of receipts. */ Receipt[];
1380
1382
  export type GetV4ManufacturerByRouteManufacturerIdDocumentsReceiptsApiArg = {
1381
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1383
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1382
1384
  routeManufacturerId: string;
1383
1385
  };
1384
1386
  export type GetV4ManufacturerByRouteManufacturerIdDocumentReceiptsApiResponse =
1385
1387
  /** status 200 A list of receipts. */ Receipt[];
1386
1388
  export type GetV4ManufacturerByRouteManufacturerIdDocumentReceiptsApiArg = {
1387
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1389
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1388
1390
  routeManufacturerId: string;
1389
1391
  };
1390
1392
  export type GetV4ManufacturerByRouteManufacturerIdDocumentsInvoicesApiResponse =
1391
1393
  /** status 200 A list of invoices. */ VendorDocument[];
1392
1394
  export type GetV4ManufacturerByRouteManufacturerIdDocumentsInvoicesApiArg = {
1393
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1395
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1394
1396
  routeManufacturerId: string;
1395
1397
  };
1396
1398
  export type GetV4ManufacturerByRouteManufacturerIdDocumentInvoicesApiResponse =
1397
1399
  /** status 200 A list of invoices. */ VendorDocument[];
1398
1400
  export type GetV4ManufacturerByRouteManufacturerIdDocumentInvoicesApiArg = {
1399
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1401
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1400
1402
  routeManufacturerId: string;
1401
1403
  };
1402
1404
  export type GetV4ManufacturerByRouteManufacturerIdDocumentsActiveOrderDetailsApiResponse =
1403
1405
  /** status 200 A list of active order details. */ OrderDetail[];
1404
1406
  export type GetV4ManufacturerByRouteManufacturerIdDocumentsActiveOrderDetailsApiArg = {
1405
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1407
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1406
1408
  routeManufacturerId: string;
1407
1409
  };
1408
1410
  export type GetV4ManufacturerByRouteManufacturerIdDocumentActiveOrderDetailsApiResponse =
1409
1411
  /** status 200 A list of active order details. */ OrderDetail[];
1410
1412
  export type GetV4ManufacturerByRouteManufacturerIdDocumentActiveOrderDetailsApiArg = {
1411
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1413
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1412
1414
  routeManufacturerId: string;
1413
1415
  };
1414
1416
  export type GetV4ManufacturerByRouteManufacturerIdDocumentsCompletedOrderDetailsApiResponse =
1415
1417
  /** status 200 A list of completed order details. */ OrderDetail[];
1416
1418
  export type GetV4ManufacturerByRouteManufacturerIdDocumentsCompletedOrderDetailsApiArg = {
1417
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1419
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1418
1420
  routeManufacturerId: string;
1419
1421
  };
1420
1422
  export type GetV4ManufacturerByRouteManufacturerIdDocumentCompletedOrderDetailsApiResponse =
1421
1423
  /** status 200 A list of completed order details. */ OrderDetail[];
1422
1424
  export type GetV4ManufacturerByRouteManufacturerIdDocumentCompletedOrderDetailsApiArg = {
1423
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1425
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1424
1426
  routeManufacturerId: string;
1425
1427
  };
1426
1428
  export type PutV4ManufacturerByRouteManufacturerIdDraftPurchasesApiResponse = unknown;
1427
1429
  export type PutV4ManufacturerByRouteManufacturerIdDraftPurchasesApiArg = {
1428
- /** The application ID of the Manufacturer making the request. */
1430
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1429
1431
  routeManufacturerId: string;
1430
1432
  };
1431
1433
  export type PutV4PartnerEmailApiResponse = unknown;
1432
1434
  export type PutV4PartnerEmailApiArg = {
1433
1435
  /** The outbound email definition, including `ToEmails`, `Title`, `BodyHtml`, optional `ReplyTo`,
1434
- and optional publicly accessible attachment URLs. Inquiry messages must include the verified originating
1436
+ and optional publicly accessible attachment URLs. Supply a non-null ToEmails array and nonblank Title and BodyHtml.
1437
+ Inquiry messages must include the verified originating
1435
1438
  reseller/Partner and enough context for the recipient to respond. */
1436
1439
  sendEmailRequest: SendEmailRequest;
1437
1440
  };
@@ -1470,9 +1473,11 @@ export type GetV4PartnerByRouteApplicationIdGeneralDocumentsApiArg = {
1470
1473
  routeApplicationId: string;
1471
1474
  };
1472
1475
  export type PostV4PartnerByApplicationIdGenerationTextApiResponse =
1473
- /** status 200 OK */ GenerationResult;
1476
+ /** status 200 GenerationResult containing the generated content and context utilization. */ GenerationResult;
1474
1477
  export type PostV4PartnerByApplicationIdGenerationTextApiArg = {
1478
+ /** Partner account whose authorization and generation context are used. */
1475
1479
  applicationId: string;
1480
+ /** Conversation messages in order, including roles and content parts. */
1476
1481
  body: ContentSubset[];
1477
1482
  };
1478
1483
  export type PostV4PartnerByApplicationIdGenerationGoogleGroundedTextApiResponse =
@@ -1518,15 +1523,19 @@ export type PostV4PartnerByApplicationIdGenerationUploadApiArg = {
1518
1523
  };
1519
1524
  };
1520
1525
  export type PostV4PartnerByApplicationIdGenerationV2JsonApiResponse =
1521
- /** status 200 OK */ GenerationResult;
1526
+ /** status 200 The JSON generation result. */ GenerationResult;
1522
1527
  export type PostV4PartnerByApplicationIdGenerationV2JsonApiArg = {
1528
+ /** Partner account whose authorization and generation context are used. */
1523
1529
  applicationId: string;
1530
+ /** Conversation messages in order, using the request schema for this endpoint. */
1524
1531
  body: ContentSubset[];
1525
1532
  };
1526
1533
  export type PostV4PartnerByApplicationIdGenerationV2RandmarAssistantApiResponse =
1527
- /** status 200 OK */ RandmarAssistantV2GenerationResult;
1534
+ /** status 200 The assistant text or function-call result. */ RandmarAssistantV2GenerationResult;
1528
1535
  export type PostV4PartnerByApplicationIdGenerationV2RandmarAssistantApiArg = {
1536
+ /** Partner account whose authorization and generation context are used. */
1529
1537
  applicationId: string;
1538
+ /** Conversation messages in order, using the request schema for this endpoint. */
1530
1539
  body: RandmarAssistantV2Content[];
1531
1540
  };
1532
1541
  export type PostV4PartnerByRouteApplicationIdGoogleAdsInvitationApiResponse =
@@ -1538,7 +1547,7 @@ export type PostV4PartnerByRouteApplicationIdGoogleAdsInvitationApiArg = {
1538
1547
  shopifyHostName?: string;
1539
1548
  };
1540
1549
  export type GetV4PartnerByRouteApplicationIdGoogleAdsInvitationApiResponse =
1541
- /** status 200 OK */ GoogleAdsManagerInvitationStatus;
1550
+ /** status 200 Current manager-link status. IsAccepted is true only for an ACTIVE link. */ GoogleAdsManagerInvitationStatus;
1542
1551
  export type GetV4PartnerByRouteApplicationIdGoogleAdsInvitationApiArg = {
1543
1552
  /** The Randmar application ID that owns the Shopify store. */
1544
1553
  routeApplicationId: string;
@@ -1558,7 +1567,7 @@ export type GetV4PartnerByRouteApplicationIdGoogleAdsOverviewApiArg = {
1558
1567
  endDate?: string;
1559
1568
  };
1560
1569
  export type GetV4PartnerByRouteApplicationIdGoogleAdsCampaignsApiResponse =
1561
- /** status 200 OK */ GoogleAdsCampaign[];
1570
+ /** status 200 Campaign collection; an empty collection is valid. */ GoogleAdsCampaign[];
1562
1571
  export type GetV4PartnerByRouteApplicationIdGoogleAdsCampaignsApiArg = {
1563
1572
  /** The Randmar application ID that owns the Shopify store. */
1564
1573
  routeApplicationId: string;
@@ -1590,7 +1599,7 @@ export type DeleteV4PartnerByRouteApplicationIdGoogleAdsCampaignsAndCampaignIdAp
1590
1599
  validateOnly?: boolean;
1591
1600
  };
1592
1601
  export type GetV4PartnerByRouteApplicationIdGoogleAdsCampaignsAndCampaignIdApiResponse =
1593
- /** status 200 OK */ GoogleAdsCampaignDetails;
1602
+ /** status 200 Selected campaign configuration and period totals. */ GoogleAdsCampaignDetails;
1594
1603
  export type GetV4PartnerByRouteApplicationIdGoogleAdsCampaignsAndCampaignIdApiArg = {
1595
1604
  /** The Randmar application ID that owns the Shopify store. */
1596
1605
  routeApplicationId: string;
@@ -1632,7 +1641,7 @@ export type GetV4PartnerByRouteApplicationIdGoogleAdsCampaignsAndCampaignIdConve
1632
1641
  endDate?: string;
1633
1642
  };
1634
1643
  export type GetV4PartnerByRouteApplicationIdGoogleAdsCampaignsAndCampaignIdAssetGroupsApiResponse =
1635
- /** status 200 OK */ GoogleAdsAssetGroup[];
1644
+ /** status 200 Asset-group collection for the selected campaign and reporting period. */ GoogleAdsAssetGroup[];
1636
1645
  export type GetV4PartnerByRouteApplicationIdGoogleAdsCampaignsAndCampaignIdAssetGroupsApiArg = {
1637
1646
  /** The Randmar application ID that owns the Shopify store. */
1638
1647
  routeApplicationId: string;
@@ -1646,7 +1655,7 @@ export type GetV4PartnerByRouteApplicationIdGoogleAdsCampaignsAndCampaignIdAsset
1646
1655
  endDate?: string;
1647
1656
  };
1648
1657
  export type GetV4PartnerByRouteApplicationIdGoogleAdsCampaignsAndCampaignIdAssetGroupsAssetGroupIdAssetsApiResponse =
1649
- /** status 200 OK */ GoogleAdsAssetGroupAsset[];
1658
+ /** status 200 Asset placements within the selected campaign asset group. */ GoogleAdsAssetGroupAsset[];
1650
1659
  export type GetV4PartnerByRouteApplicationIdGoogleAdsCampaignsAndCampaignIdAssetGroupsAssetGroupIdAssetsApiArg = {
1651
1660
  /** The Randmar application ID that owns the Shopify store. */
1652
1661
  routeApplicationId: string;
@@ -1662,7 +1671,7 @@ export type GetV4PartnerByRouteApplicationIdGoogleAdsCampaignsAndCampaignIdAsset
1662
1671
  endDate?: string;
1663
1672
  };
1664
1673
  export type GetV4PartnerByRouteApplicationIdGoogleAdsCampaignsAndCampaignIdAssetGroupsAssetGroupIdAssetsAssetIdApiResponse =
1665
- /** status 200 OK */ GoogleAdsAssetDetails;
1674
+ /** status 200 Selected asset and its placements within the specified group. */ GoogleAdsAssetDetails;
1666
1675
  export type GetV4PartnerByRouteApplicationIdGoogleAdsCampaignsAndCampaignIdAssetGroupsAssetGroupIdAssetsAssetIdApiArg = {
1667
1676
  /** The Randmar application ID that owns the Shopify store. */
1668
1677
  routeApplicationId: string;
@@ -1680,7 +1689,7 @@ export type GetV4PartnerByRouteApplicationIdGoogleAdsCampaignsAndCampaignIdAsset
1680
1689
  endDate?: string;
1681
1690
  };
1682
1691
  export type GetV4PartnerByRouteApplicationIdGoogleAdsBillingSetupsApiResponse =
1683
- /** status 200 OK */ GoogleAdsBillingSetup[];
1692
+ /** status 200 Billing setup records; does not create or change billing. */ GoogleAdsBillingSetup[];
1684
1693
  export type GetV4PartnerByRouteApplicationIdGoogleAdsBillingSetupsApiArg = {
1685
1694
  /** The Randmar application ID that owns the Shopify store. */
1686
1695
  routeApplicationId: string;
@@ -1718,7 +1727,7 @@ export type GetV4PartnerByRouteApplicationIdIntegrationKeysApiArg = {
1718
1727
  export type GetV4ManufacturerByRouteManufacturerIdInventoryValueApiResponse =
1719
1728
  /** status 200 A list of inventory values. */ InventoryValueEntry[];
1720
1729
  export type GetV4ManufacturerByRouteManufacturerIdInventoryValueApiArg = {
1721
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1730
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1722
1731
  routeManufacturerId: string;
1723
1732
  };
1724
1733
  export type GetV4PartnerByRouteApplicationIdJobAndJobIdApiResponse =
@@ -1773,7 +1782,7 @@ export type PutV4PartnerByRouteApplicationIdJobsAssistantTaskAndJobIdScheduledTi
1773
1782
  routeApplicationId: string;
1774
1783
  /** The assistant task job ID. */
1775
1784
  jobId: string;
1776
- /** The new scheduled timestamp, in UTC Unix seconds. Use 0 to clear the scheduled time. */
1785
+ /** JSON object with scheduledTimeSecondsUTC in UTC Unix seconds, more than one minute in the future. Zero is rejected. */
1777
1786
  setPartnerAssistantJobScheduledTimeInput: SetPartnerAssistantJobScheduledTimeInput;
1778
1787
  };
1779
1788
  export type GetV4PartnerByRouteApplicationIdLogsApiResponse = unknown;
@@ -1884,7 +1893,7 @@ export type GetV4AgencyByRouteAgencyIdManufacturersApiResponse =
1884
1893
  export type GetV4AgencyByRouteAgencyIdManufacturersApiArg = {
1885
1894
  /** The target agency application ID. Not HQ IDs such as `2` or `FGDCT3037`. Resolve partner/agency names via `GET V4/Intranet/Search/Partners`. */
1886
1895
  routeAgencyId: string;
1887
- /** Whether to include detailed specifications for each manufacturer. Defaults to false. */
1896
+ /** Query flag, false by default. True adds SalesData and InventoryValue to each represented manufacturer. */
1888
1897
  withSpecification?: boolean;
1889
1898
  };
1890
1899
  export type GetV4AgencyByRouteAgencyIdManufacturersOpenOrdersApiResponse =
@@ -1947,7 +1956,7 @@ export type GetV4PartnerByRouteApplicationIdMicrosoftAdsAccountsApiArg = {
1947
1956
  shopifyHostName?: string;
1948
1957
  };
1949
1958
  export type PostV4PartnerByRouteApplicationIdMicrosoftAdsAccountLinksApiResponse =
1950
- /** status 200 OK */ MicrosoftAdsAccountLinkResult;
1959
+ /** status 200 Management-link result; a pending invitation still requires client acceptance. */ MicrosoftAdsAccountLinkResult;
1951
1960
  export type PostV4PartnerByRouteApplicationIdMicrosoftAdsAccountLinksApiArg = {
1952
1961
  /** The Randmar application ID requesting the management link. */
1953
1962
  routeApplicationId: string;
@@ -1972,7 +1981,7 @@ export type GetV4ResellerByRouteResellerIdOpportunitiesApiArg = {
1972
1981
  };
1973
1982
  export type GetV4ManufacturerByRouteManufacturerIdOpportunitiesApiResponse = unknown;
1974
1983
  export type GetV4ManufacturerByRouteManufacturerIdOpportunitiesApiArg = {
1975
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
1984
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
1976
1985
  routeManufacturerId: string;
1977
1986
  };
1978
1987
  export type GetV4ResellerByRouteResellerIdOpportunityAndManufacturerIdBidNumberApiResponse =
@@ -2029,99 +2038,99 @@ export type PostV4ResellerByRouteResellerIdOpportunityAndManufacturerIdBidNumber
2029
2038
  };
2030
2039
  export type PutV4ManufacturerByRouteManufacturerIdOpportunityApiResponse = unknown;
2031
2040
  export type PutV4ManufacturerByRouteManufacturerIdOpportunityApiArg = {
2032
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2041
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2033
2042
  routeManufacturerId: string;
2034
- /** The opportunity payload (bid number, title, dates, default resellers, quoteOnly). */
2043
+ /** JSON request body. The opportunity payload (bid number, title, dates, default resellers, quoteOnly). */
2035
2044
  createOpportunityInput: CreateOpportunityInput;
2036
2045
  };
2037
2046
  export type PutV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberApiResponse = unknown;
2038
2047
  export type PutV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberApiArg = {
2039
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2048
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2040
2049
  routeManufacturerId: string;
2041
- /** The existing bid number to renew. Resolve from `GET .../Opportunities`. */
2050
+ /** Path parameter. The existing bid number to renew. Resolve from `GET .../Opportunities`. */
2042
2051
  bidNumber: string;
2043
- /** The new bid number, title, dates, and quoteOnly for the renewal. */
2052
+ /** JSON request body. The new bid number, title, dates, and quoteOnly for the renewal. */
2044
2053
  renewOpportunityInput: RenewOpportunityInput;
2045
2054
  };
2046
2055
  export type GetV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberApiResponse =
2047
2056
  /** status 200 The requested opportunity's data. */ OpportunityEntry;
2048
2057
  export type GetV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberApiArg = {
2049
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2058
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2050
2059
  routeManufacturerId: string;
2051
- /** The bid number. Resolve from `GET .../Opportunities` if unknown. */
2060
+ /** Path parameter. The bid number. Resolve from `GET .../Opportunities` if unknown. */
2052
2061
  bidNumber: string;
2053
- /** If true, includes detailed specifications. Defaults to true. */
2062
+ /** Query parameter. If true, includes detailed specifications. Defaults to true. */
2054
2063
  withSpecification?: boolean;
2055
2064
  };
2056
2065
  export type DeleteV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberApiResponse = unknown;
2057
2066
  export type DeleteV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberApiArg = {
2058
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2067
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2059
2068
  routeManufacturerId: string;
2060
- /** The bid number to delete. Resolve from `GET .../Opportunities`. */
2069
+ /** Path parameter. The bid number to delete. Resolve from `GET .../Opportunities`. */
2061
2070
  bidNumber: string;
2062
2071
  };
2063
2072
  export type PostV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberFieldNameApiResponse = unknown;
2064
2073
  export type PostV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberFieldNameApiArg = {
2065
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2074
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2066
2075
  routeManufacturerId: string;
2067
- /** The bid number to edit. Resolve from `GET .../Opportunities`. */
2076
+ /** Path parameter. The bid number to edit. Resolve from `GET .../Opportunities`. */
2068
2077
  bidNumber: string;
2069
- /** The opportunity field to edit. Case-sensitive; use the name from the opportunity JSON. */
2078
+ /** Path parameter. The opportunity field to edit. Case-sensitive; use the name from the opportunity JSON. */
2070
2079
  fieldName: string;
2071
- /** The new value for the field. */
2080
+ /** Query parameter. The new value for the field. */
2072
2081
  newValue?: string;
2073
2082
  };
2074
2083
  export type PutV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberResellerResellerIdApiResponse = unknown;
2075
2084
  export type PutV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberResellerResellerIdApiArg = {
2076
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2085
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2077
2086
  routeManufacturerId: string;
2078
- /** The bid number to edit. */
2087
+ /** Path parameter. The bid number to edit. */
2079
2088
  bidNumber: string;
2080
- /** The reseller application ID to add. Resolve from the Resellers list. */
2089
+ /** Path parameter. The reseller application ID to add. Resolve from the Resellers list. */
2081
2090
  resellerId: string;
2082
2091
  };
2083
2092
  export type DeleteV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberResellerResellerIdApiResponse = unknown;
2084
2093
  export type DeleteV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberResellerResellerIdApiArg = {
2085
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2094
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2086
2095
  routeManufacturerId: string;
2087
- /** The bid number to edit. */
2096
+ /** Path parameter. The bid number to edit. */
2088
2097
  bidNumber: string;
2089
- /** The reseller application ID to remove from the bid. */
2098
+ /** Path parameter. The reseller application ID to remove from the bid. */
2090
2099
  resellerId: string;
2091
2100
  };
2092
2101
  export type PostV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberResellerResellerIdEmailApiResponse = unknown;
2093
2102
  export type PostV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberResellerResellerIdEmailApiArg = {
2094
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2103
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2095
2104
  routeManufacturerId: string;
2096
- /** The bid number to send. */
2105
+ /** Path parameter. The bid number to send. */
2097
2106
  bidNumber: string;
2098
- /** The reseller application ID on whose behalf the email is sent. */
2107
+ /** Path parameter. The reseller application ID on whose behalf the email is sent. */
2099
2108
  resellerId: string;
2100
- /** The recipient email address. Confirm with the user; do not guess. */
2109
+ /** Query parameter. The recipient email address. Confirm with the user; do not guess. */
2101
2110
  emailAddress?: string;
2102
2111
  };
2103
2112
  export type PostV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberPartNumberRandmarSkuApiResponse = unknown;
2104
2113
  export type PostV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberPartNumberRandmarSkuApiArg = {
2105
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2114
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2106
2115
  routeManufacturerId: string;
2107
- /** The bid number to edit. */
2116
+ /** Path parameter. The bid number to edit. */
2108
2117
  bidNumber: string;
2109
- /** The Randmar SKU to add or update. Resolve from product GET if the user gave an MPN/UPC. */
2118
+ /** Path parameter. The Randmar SKU to add or update. Resolve from product GET if the user gave an MPN/UPC. */
2110
2119
  randmarSku: string;
2111
- /** The bid amount (e.g., rebate value). */
2120
+ /** Query parameter. The bid amount (e.g., rebate value). */
2112
2121
  bidPrice?: number;
2113
- /** The bid amount type. Defaults to "ItemRebate". */
2122
+ /** Query parameter. The bid amount type. Defaults to "ItemRebate". */
2114
2123
  bidPriceType?: string;
2115
- /** If true, marks the bid as a Randmar discount. Requires super-admin authorization. */
2124
+ /** Query parameter. If true, marks the bid as a Randmar discount. Requires super-admin authorization. */
2116
2125
  randmarDiscount?: boolean;
2117
2126
  };
2118
2127
  export type DeleteV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberPartNumberRandmarSkuApiResponse = unknown;
2119
2128
  export type DeleteV4ManufacturerByRouteManufacturerIdOpportunityAndBidNumberPartNumberRandmarSkuApiArg = {
2120
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2129
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2121
2130
  routeManufacturerId: string;
2122
- /** The bid number to edit. */
2131
+ /** Path parameter. The bid number to edit. */
2123
2132
  bidNumber: string;
2124
- /** The Randmar SKU to remove. Resolve from product GET if the user gave an MPN/UPC. */
2133
+ /** Path parameter. The Randmar SKU to remove. Resolve from product GET if the user gave an MPN/UPC. */
2125
2134
  randmarSku: string;
2126
2135
  };
2127
2136
  export type GetV4ResellerByRouteResellerIdOrderAndOrderNumberApiResponse =
@@ -2175,7 +2184,9 @@ export type PostV4ResellerByRouteResellerIdOrderAndOrderNumberEmailApiArg = {
2175
2184
  };
2176
2185
  export type PostV4ResellerByRouteResellerIdOrderAndDocumentNumberLuggaBeastApiResponse = unknown;
2177
2186
  export type PostV4ResellerByRouteResellerIdOrderAndDocumentNumberLuggaBeastApiArg = {
2187
+ /** Reseller application ID used to retrieve the document and notification recipients. */
2178
2188
  routeResellerId: string;
2189
+ /** General-document or order identifier to include in the confirmation. */
2179
2190
  documentNumber: string;
2180
2191
  };
2181
2192
  export type DeleteV4ResellerByRouteResellerIdOrderAndOrderNumberCancelApiResponse = unknown;
@@ -2378,7 +2389,9 @@ export type GetV4PartnerByRouteApplicationIdPartnerAndPartnerIdApiArg = {
2378
2389
  };
2379
2390
  export type PutV4AgencyByRouteAgencyIdPartnerAndNewUserEmailAddressApiResponse = unknown;
2380
2391
  export type PutV4AgencyByRouteAgencyIdPartnerAndNewUserEmailAddressApiArg = {
2392
+ /** The target sales agency's application ID, accessible to the caller. */
2381
2393
  routeAgencyId: string;
2394
+ /** URL-encoded destination email address for the invitation. */
2382
2395
  newUserEmailAddress: string;
2383
2396
  };
2384
2397
  export type GetV4ShopifyByShopifyHostNameProductAndRandmarSkuApiResponse =
@@ -2522,47 +2535,47 @@ export type PutV4PartnerByRouteApplicationIdProductAndRandmarSkuLocationDetailsW
2522
2535
  export type GetV4ManufacturerByRouteManufacturerIdProductAndProductNumberApiResponse =
2523
2536
  /** status 200 The requested product's data. */ Product;
2524
2537
  export type GetV4ManufacturerByRouteManufacturerIdProductAndProductNumberApiArg = {
2525
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2538
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2526
2539
  routeManufacturerId: string;
2527
- /** The Randmar SKU, MPN, or UPC of the product to retrieve. */
2540
+ /** Path parameter. The Randmar SKU, MPN, or UPC of the product to retrieve. */
2528
2541
  productNumber: string;
2529
- /** If true, includes detailed specifications in the response. Defaults to true. */
2542
+ /** Query parameter. If true, includes detailed specifications in the response. Defaults to true. */
2530
2543
  withSpecification?: boolean;
2531
2544
  };
2532
2545
  export type GetV4ManufacturerByRouteManufacturerIdProductAndProductNumberSalesStatisticsApiResponse =
2533
2546
  /** status 200 A list of sales statistics for the product. */ SalesStatistic[];
2534
2547
  export type GetV4ManufacturerByRouteManufacturerIdProductAndProductNumberSalesStatisticsApiArg = {
2535
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2548
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2536
2549
  routeManufacturerId: string;
2537
- /** The Randmar SKU, MPN, or UPC of the product. */
2550
+ /** Path parameter. The Randmar SKU, MPN, or UPC of the product. */
2538
2551
  productNumber: string;
2539
- /** Optional start date for the reporting period. */
2552
+ /** Query parameter. Optional start date; defaults to one year before the current server time. */
2540
2553
  startDate?: string;
2541
- /** Optional end date for the reporting period. */
2554
+ /** Query parameter. Optional end date; defaults to the current server time. */
2542
2555
  endDate?: string;
2543
2556
  };
2544
2557
  export type PutV4ManufacturerByRouteManufacturerIdProductApiResponse =
2545
2558
  /** status 200 The newly created product object (some fields may require re-fetch by Randmar SKU). */ Product;
2546
2559
  export type PutV4ManufacturerByRouteManufacturerIdProductApiArg = {
2547
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2560
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2548
2561
  routeManufacturerId: string;
2549
- /** The details of the product to create. */
2562
+ /** JSON request body. The details of the product to create. */
2550
2563
  insertProductInput: InsertProductInput;
2551
2564
  };
2552
2565
  export type PostV4ManufacturerByRouteManufacturerIdProductAndProductNumberFieldNameApiResponse =
2553
- /** status 200 A boolean: true if the update succeeded, false if validation, product lookup, or persistence failed. Re-fetch to verify. */ boolean;
2566
+ /** status 200 True if the update was successful. */ boolean;
2554
2567
  export type PostV4ManufacturerByRouteManufacturerIdProductAndProductNumberFieldNameApiArg = {
2555
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2568
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2556
2569
  routeManufacturerId: string;
2557
- /** The Randmar SKU, MPN or UPC of the product to edit. */
2570
+ /** Path parameter. The Randmar SKU, MPN or UPC of the product to edit. */
2558
2571
  productNumber: string;
2559
- /** Case-sensitive field name from the supported list in this operation's description. */
2572
+ /** Path parameter. Case-sensitive supported field: State, CountryCodeOfOrigin, UnitHeight, UnitLength, UnitWidth, Require3DScan, MasterCarton, UnitWeight, OpportunityOnly, TransparencyCode, SerialNumber, Category, StandardCost, MPN, AutoUpdate, SkidQuantity, Title, MSRP, MAP, BodyHTML, VoiceoverCaption, or SceneName. */
2560
2573
  fieldName: string;
2561
- /** Scalar new value serialized as a query parameter string. */
2574
+ /** Query parameter. The new value for the field. */
2562
2575
  newValue?: string;
2563
2576
  };
2564
2577
  export type PostV4ManufacturerByRouteManufacturerIdProductAndProductNumberBodyHtmlApiResponse =
2565
- /** status 200 A boolean: true if the update succeeded, false if the product could not be found or persistence failed. Re-fetch to verify. */ boolean;
2578
+ /** status 200 True if the update was successful. */ boolean;
2566
2579
  export type PostV4ManufacturerByRouteManufacturerIdProductAndProductNumberBodyHtmlApiArg = {
2567
2580
  /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2568
2581
  routeManufacturerId: string;
@@ -2578,65 +2591,65 @@ export type PostV4ManufacturerByRouteManufacturerIdProductAndProductNumberRandma
2578
2591
  };
2579
2592
  export type PostV4ManufacturerByRouteManufacturerIdProductAndProductNumberDiscontinueApiResponse = unknown;
2580
2593
  export type PostV4ManufacturerByRouteManufacturerIdProductAndProductNumberDiscontinueApiArg = {
2581
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2594
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2582
2595
  routeManufacturerId: string;
2583
- /** The Randmar SKU, MPN, or UPC of the product to discontinue. */
2596
+ /** Path parameter. The Randmar SKU, MPN, or UPC of the product to discontinue. */
2584
2597
  productNumber: string;
2585
2598
  };
2586
2599
  export type DeleteV4ManufacturerByRouteManufacturerIdProductAndProductNumberOrderNumberApiResponse = unknown;
2587
2600
  export type DeleteV4ManufacturerByRouteManufacturerIdProductAndProductNumberOrderNumberApiArg = {
2588
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2601
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2589
2602
  routeManufacturerId: string;
2590
- /** The Randmar SKU, MPN, or UPC of the product to cancel. */
2603
+ /** Path parameter. The Randmar SKU, MPN, or UPC of the product to cancel. */
2591
2604
  productNumber: string;
2592
- /** The order number from which to cancel the product. */
2605
+ /** Path parameter. The order number from which to cancel the product. */
2593
2606
  orderNumber: string;
2594
- /** An optional comment for the cancellation reason. */
2607
+ /** Query parameter. An optional comment for the cancellation reason. */
2595
2608
  comment?: string;
2596
2609
  };
2597
2610
  export type PostV4ManufacturerByRouteManufacturerIdProductAndProductNumberUpcApiResponse = unknown;
2598
2611
  export type PostV4ManufacturerByRouteManufacturerIdProductAndProductNumberUpcApiArg = {
2599
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2612
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2600
2613
  routeManufacturerId: string;
2601
- /** The Randmar SKU or MPN of the product to update. */
2614
+ /** Path parameter. The Randmar SKU or MPN of the product to update. */
2602
2615
  productNumber: string;
2603
- /** The new UPC value. */
2616
+ /** Query parameter. The new UPC value. */
2604
2617
  newValue?: string;
2605
2618
  };
2606
2619
  export type PutV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuInstantRebateApiResponse = unknown;
2607
2620
  export type PutV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuInstantRebateApiArg = {
2608
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2621
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2609
2622
  routeManufacturerId: string;
2610
- /** The Randmar SKU of the product to apply the rebate to. */
2623
+ /** Path parameter. The Randmar SKU of the product to apply the rebate to. */
2611
2624
  randmarSku: string;
2612
- /** The details of the instant rebate. */
2625
+ /** JSON request body. The details of the instant rebate. */
2613
2626
  instantRebateInput: InstantRebateInput;
2614
2627
  };
2615
2628
  export type PutV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuRequisitionApiResponse = unknown;
2616
2629
  export type PutV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuRequisitionApiArg = {
2617
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2630
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2618
2631
  routeManufacturerId: string;
2619
- /** The Randmar SKU of the product to add. */
2632
+ /** Path parameter. The Randmar SKU of the product to add. */
2620
2633
  randmarSku: string;
2621
- /** The warehouse location code for the requisition. */
2634
+ /** Query parameter. The warehouse location code for the requisition. */
2622
2635
  location?: string;
2623
- /** The quantity to add (should be the product `MasterCarton` value). */
2636
+ /** Query parameter. The quantity to add (should be the product `MasterCarton` value). */
2624
2637
  quantity?: number;
2625
2638
  };
2626
2639
  export type GetV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuImagesApiResponse =
2627
2640
  /** status 200 A list of product images. */ ProductImageInfo[];
2628
2641
  export type GetV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuImagesApiArg = {
2629
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2642
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2630
2643
  routeManufacturerId: string;
2631
- /** The Randmar SKU of the product. */
2644
+ /** Path parameter. The Randmar SKU of the product. */
2632
2645
  randmarSku: string;
2633
2646
  };
2634
2647
  export type PostV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuImagesApiResponse =
2635
2648
  /** status 200 Information about the uploaded image. */ ProductImageUploadResult;
2636
2649
  export type PostV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuImagesApiArg = {
2637
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2650
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2638
2651
  routeManufacturerId: string;
2639
- /** The Randmar SKU of the product. */
2652
+ /** Path parameter. The Randmar SKU of the product. */
2640
2653
  randmarSku: string;
2641
2654
  body: {
2642
2655
  /** The image file to upload. */
@@ -2650,101 +2663,101 @@ export type PostV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuImagesApi
2650
2663
  export type PutV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuAttachmentApiResponse =
2651
2664
  /** status 200 The registered attachment UUID. */ string;
2652
2665
  export type PutV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuAttachmentApiArg = {
2653
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2666
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2654
2667
  routeManufacturerId: string;
2655
- /** The Randmar SKU of the product. */
2668
+ /** Path parameter. The Randmar SKU of the product. */
2656
2669
  randmarSku: string;
2657
- /** The registration payload containing the temporary storage key. */
2670
+ /** JSON request body. The registration payload containing the temporary storage key. */
2658
2671
  randmarApiControllersV4ManufacturerProductControllerRegisterProductAttachmentRequest: RandmarApiControllersV4ManufacturerProductControllerRegisterProductAttachmentRequest;
2659
2672
  };
2660
2673
  export type PostV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuAppendImageApiResponse =
2661
2674
  /** status 200 Information about the appended image. */ ProductImageUploadResult;
2662
2675
  export type PostV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuAppendImageApiArg = {
2663
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2676
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2664
2677
  routeManufacturerId: string;
2665
- /** The Randmar SKU of the product. */
2678
+ /** Path parameter. The Randmar SKU of the product. */
2666
2679
  randmarSku: string;
2667
- /** JSON payload containing the public image URL and optional metadata. */
2680
+ /** JSON request body. JSON payload containing the public image URL and optional metadata. */
2668
2681
  randmarApiControllersV4ManufacturerProductControllerAppendProductImageRequest: RandmarApiControllersV4ManufacturerProductControllerAppendProductImageRequest;
2669
2682
  };
2670
2683
  export type PostV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuImagesImageIdPrimaryApiResponse = unknown;
2671
2684
  export type PostV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuImagesImageIdPrimaryApiArg = {
2672
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2685
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2673
2686
  routeManufacturerId: string;
2674
- /** The Randmar SKU of the product. */
2687
+ /** Path parameter. The Randmar SKU of the product. */
2675
2688
  randmarSku: string;
2676
- /** The image ID to set as primary. */
2689
+ /** Path parameter. The image ID to set as primary. */
2677
2690
  imageId: string;
2678
2691
  };
2679
2692
  export type PostV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuImagesReorderApiResponse = unknown;
2680
2693
  export type PostV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuImagesReorderApiArg = {
2681
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2694
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2682
2695
  routeManufacturerId: string;
2683
- /** The Randmar SKU of the product. */
2696
+ /** Path parameter. The Randmar SKU of the product. */
2684
2697
  randmarSku: string;
2685
- /** The desired image ordering. */
2698
+ /** JSON request body. The desired image ordering. */
2686
2699
  reorderProductImagesInput: ReorderProductImagesInput;
2687
2700
  };
2688
2701
  export type DeleteV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuImagesImageIdApiResponse = unknown;
2689
2702
  export type DeleteV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuImagesImageIdApiArg = {
2690
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2703
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2691
2704
  routeManufacturerId: string;
2692
- /** The Randmar SKU of the product. */
2705
+ /** Path parameter. The Randmar SKU of the product. */
2693
2706
  randmarSku: string;
2694
- /** The image ID to delete. */
2707
+ /** Path parameter. The image ID to delete. */
2695
2708
  imageId: string;
2696
2709
  };
2697
2710
  export type PostV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuImageApiResponse = unknown;
2698
2711
  export type PostV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuImageApiArg = {
2699
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2712
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2700
2713
  routeManufacturerId: string;
2701
- /** The Randmar SKU of the product to update. */
2714
+ /** Path parameter. The Randmar SKU of the product to update. */
2702
2715
  randmarSku: string;
2703
2716
  body: {
2704
- /** The image file to upload. */
2717
+ /** Multipart form field. The image file to upload. */
2705
2718
  file?: Blob;
2706
2719
  };
2707
2720
  };
2708
2721
  export type PutV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuGenerateImageApiResponse = unknown;
2709
2722
  export type PutV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuGenerateImageApiArg = {
2710
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2723
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2711
2724
  routeManufacturerId: string;
2712
- /** The Randmar SKU of the product. */
2725
+ /** Path parameter. The Randmar SKU of the product. */
2713
2726
  randmarSku: string;
2714
2727
  };
2715
2728
  export type GetV4ManufacturerByRouteManufacturerIdProductAndProductNumber3DModelApiResponse = unknown;
2716
2729
  export type GetV4ManufacturerByRouteManufacturerIdProductAndProductNumber3DModelApiArg = {
2717
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2730
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2718
2731
  routeManufacturerId: string;
2719
- /** The Randmar SKU, MPN, or UPC of the product. */
2732
+ /** Path parameter. The Randmar SKU, MPN, or UPC of the product. */
2720
2733
  productNumber: string;
2721
2734
  };
2722
2735
  export type GetV4ManufacturerByRouteManufacturerIdProductAndProductNumber3DModelExistsApiResponse = unknown;
2723
2736
  export type GetV4ManufacturerByRouteManufacturerIdProductAndProductNumber3DModelExistsApiArg = {
2724
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2737
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2725
2738
  routeManufacturerId: string;
2726
- /** The Randmar SKU, MPN, or UPC of the product. */
2739
+ /** Path parameter. The Randmar SKU, MPN, or UPC of the product. */
2727
2740
  productNumber: string;
2728
2741
  };
2729
2742
  export type PostV4ManufacturerByRouteManufacturerIdProductAndRandmarSku3DModelApiResponse = unknown;
2730
2743
  export type PostV4ManufacturerByRouteManufacturerIdProductAndRandmarSku3DModelApiArg = {
2731
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2744
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2732
2745
  routeManufacturerId: string;
2733
- /** The Randmar SKU of the product to update. */
2746
+ /** Path parameter. The Randmar SKU of the product to update. */
2734
2747
  randmarSku: string;
2735
2748
  body: {
2736
- /** The 3D model file to upload (e.g., .glb). */
2749
+ /** Multipart form field. The 3D model file to upload (e.g., .glb). */
2737
2750
  file?: Blob;
2738
2751
  };
2739
2752
  };
2740
2753
  export type PostV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuVideoApiResponse = unknown;
2741
2754
  export type PostV4ManufacturerByRouteManufacturerIdProductAndRandmarSkuVideoApiArg = {
2742
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2755
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2743
2756
  routeManufacturerId: string;
2744
- /** The Randmar SKU of the product to update. */
2757
+ /** Path parameter. The Randmar SKU of the product to update. */
2745
2758
  randmarSku: string;
2746
2759
  body: {
2747
- /** The video file to upload. */
2760
+ /** Multipart form field. The video file to upload. */
2748
2761
  file?: Blob;
2749
2762
  };
2750
2763
  };
@@ -2781,7 +2794,7 @@ export type GetV4PartnerByRouteApplicationIdProductsApiArg = {
2781
2794
  export type GetV4ManufacturerByRouteManufacturerIdProductsApiResponse =
2782
2795
  /** status 200 A list of products. */ Product[];
2783
2796
  export type GetV4ManufacturerByRouteManufacturerIdProductsApiArg = {
2784
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2797
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2785
2798
  routeManufacturerId: string;
2786
2799
  };
2787
2800
  export type GetGuidelinesApiResponse = unknown;
@@ -2867,7 +2880,7 @@ export type GetProductByRandmarSkuImageAndImageIdApiArg = {
2867
2880
  width?: number;
2868
2881
  /** Optional desired height of the image. */
2869
2882
  height?: number;
2870
- /** Optional alignment for letterboxing (Left/Right). */
2883
+ /** Optional horizontal alignment for padding: Left or Right (case-insensitive); otherwise centered. */
2871
2884
  align?: string;
2872
2885
  };
2873
2886
  export type GetProductByRandmarSkuImageApiResponse = unknown;
@@ -2931,87 +2944,94 @@ export type GetShortsGenerationContentSceneBySceneNameAmbientSoundApiArg = {
2931
2944
  };
2932
2945
  export type GetWarehousesByPostalCodeApiResponse = unknown;
2933
2946
  export type GetWarehousesByPostalCodeApiArg = {
2934
- /** Ship-to postal/ZIP code. */
2947
+ /** Query ship-to postal/ZIP code; send the canonical uppercase form because matching uses stored prefixes. */
2935
2948
  postalCode?: string;
2936
- /** Ship-to country code (typically CA or US). */
2949
+ /** Query country code, normally CA or US. Empty values default to CA; matching is case-sensitive. */
2937
2950
  country?: string;
2938
2951
  };
2939
2952
  export type PutV4ManufacturerByRouteManufacturerIdPurchaseOrderApiResponse =
2940
2953
  /** status 200 The purchase order number of the newly created purchase order. */ string;
2941
2954
  export type PutV4ManufacturerByRouteManufacturerIdPurchaseOrderApiArg = {
2942
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2955
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2943
2956
  routeManufacturerId: string;
2944
- /** If true, the PO is sent to the manufacturer on create. Defaults to true—confirm with the user before calling. */
2957
+ /** Query parameter. If true, the PO is sent to the manufacturer on create. Defaults to true—confirm with the user before calling. */
2945
2958
  sendToManufacturer?: boolean;
2946
- /** Requisition numbers to include. Obtain from `GET .../Documents/Requisitions`. */
2959
+ /** JSON request body. Requisition numbers to include. Obtain from `GET .../Documents/Requisitions`. */
2947
2960
  body: string[];
2948
2961
  };
2949
2962
  export type PostV4ManufacturerByRouteManufacturerIdPurchaseOrderCreditCheckApiResponse = unknown;
2950
2963
  export type PostV4ManufacturerByRouteManufacturerIdPurchaseOrderCreditCheckApiArg = {
2951
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2964
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2952
2965
  routeManufacturerId: string;
2953
- /** Requisition numbers to credit-check. Obtain from `GET .../Documents/Requisitions`. */
2966
+ /** JSON request body. Requisition numbers to credit-check. Obtain from `GET .../Documents/Requisitions`. */
2954
2967
  body: string[];
2955
2968
  };
2956
2969
  export type PostV4ManufacturerByRouteManufacturerIdPurchaseOrderAndPurchaseOrderNumberEditExpectedDateApiResponse = unknown;
2957
2970
  export type PostV4ManufacturerByRouteManufacturerIdPurchaseOrderAndPurchaseOrderNumberEditExpectedDateApiArg = {
2958
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2971
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2959
2972
  routeManufacturerId: string;
2960
- /** The PO number (typically starts with PO). Resolve from Documents/PurchaseOrders if unknown. */
2973
+ /** Path parameter. The PO number (typically starts with PO). Resolve from Documents/PurchaseOrders if unknown. */
2961
2974
  purchaseOrderNumber: string;
2962
- /** The new expected date as a string (e.g., "YYYYMMDD"). */
2975
+ /** Query parameter. The new expected date as a string (e.g., "YYYYMMDD"). */
2963
2976
  newValue?: string;
2964
2977
  };
2965
2978
  export type DeleteV4ManufacturerByRouteManufacturerIdPurchaseOrderAndPurchaseOrderNumberApiResponse = unknown;
2966
2979
  export type DeleteV4ManufacturerByRouteManufacturerIdPurchaseOrderAndPurchaseOrderNumberApiArg = {
2967
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2980
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2968
2981
  routeManufacturerId: string;
2969
- /** The PO number to cancel. Resolve from Documents/PurchaseOrders if unknown. */
2982
+ /** Path parameter. The PO number to cancel. Resolve from Documents/PurchaseOrders if unknown. */
2970
2983
  purchaseOrderNumber: string;
2971
2984
  };
2972
2985
  export type PutV4ManufacturerByRouteManufacturerIdPurchaseOrderAndPurchaseOrderNumberSendApiResponse = unknown;
2973
2986
  export type PutV4ManufacturerByRouteManufacturerIdPurchaseOrderAndPurchaseOrderNumberSendApiArg = {
2974
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2987
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2975
2988
  routeManufacturerId: string;
2976
- /** The PO number to send. Resolve from Documents/PurchaseOrders if unknown. */
2989
+ /** Path parameter. The PO number to send. Resolve from Documents/PurchaseOrders if unknown. */
2977
2990
  purchaseOrderNumber: string;
2978
2991
  };
2979
2992
  export type PostV4ManufacturerByRouteManufacturerIdPurchaseOrderAndPurchaseOrderNumberEditItemRandmarSkuApiResponse = unknown;
2980
2993
  export type PostV4ManufacturerByRouteManufacturerIdPurchaseOrderAndPurchaseOrderNumberEditItemRandmarSkuApiArg = {
2981
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
2994
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
2982
2995
  routeManufacturerId: string;
2983
- /** The PO number to edit. */
2996
+ /** Path parameter. The PO number to edit. */
2984
2997
  purchaseOrderNumber: string;
2985
- /** The Randmar SKU on the PO. Resolve from product GET if the user gave an MPN/UPC. */
2998
+ /** Path parameter. The Randmar SKU on the PO. Resolve from product GET if the user gave an MPN/UPC. */
2986
2999
  randmarSku: string;
2987
- /** New quantity. 0 removes the item from the PO. */
3000
+ /** Query parameter. Optional replacement order quantity; null leaves quantity unchanged. */
2988
3001
  quantity?: number;
2989
- /** New unit price for the line. */
3002
+ /** Query parameter. Optional replacement unit price. Values at or below zero are ignored. */
2990
3003
  unitPrice?: number;
2991
- /** If true, also sets standard cost to unitPrice (catalog cost change). */
3004
+ /** Query parameter. Defaults to false. When true and a positive unitPrice is supplied, also attempts to update the product StandardCost. */
2992
3005
  editStandardCost?: boolean;
2993
3006
  };
2994
3007
  export type GetV4PartnerByRouteApplicationIdStripeSubscriptionApiResponse =
2995
- /** status 200 OK */ RandmarSubscriptionStatus;
3008
+ /** status 200 Saved subscription status, including a default unsubscribed status when no subscription record exists. Response is not cached. */ RandmarSubscriptionStatus;
2996
3009
  export type GetV4PartnerByRouteApplicationIdStripeSubscriptionApiArg = {
3010
+ /** Partner application ID identifying the reseller. */
2997
3011
  routeApplicationId: string;
2998
3012
  };
2999
3013
  export type PostV4PartnerByRouteApplicationIdStripeSubscriptionCheckoutApiResponse =
3000
- /** status 200 OK */ RandmarSubscriptionSession;
3014
+ /** status 200 Hosted session URL. Opening a session does not confirm a billing change. */ RandmarSubscriptionSession;
3001
3015
  export type PostV4PartnerByRouteApplicationIdStripeSubscriptionCheckoutApiArg = {
3016
+ /** Partner application ID identifying the reseller; requires authorization for this account. */
3002
3017
  routeApplicationId: string;
3018
+ /** When true, return HTTP 303 with the hosted URL in Location; otherwise return a JSON SessionUrl. */
3003
3019
  redirect?: boolean;
3004
3020
  };
3005
3021
  export type PostV4PartnerByRouteApplicationIdStripeSubscriptionCancelApiResponse =
3006
- /** status 200 OK */ RandmarSubscriptionSession;
3022
+ /** status 200 Hosted session URL. Opening a session does not confirm a billing change. */ RandmarSubscriptionSession;
3007
3023
  export type PostV4PartnerByRouteApplicationIdStripeSubscriptionCancelApiArg = {
3024
+ /** Partner application ID identifying the reseller; requires authorization for this account. */
3008
3025
  routeApplicationId: string;
3026
+ /** When true, return HTTP 303 with the hosted URL in Location; otherwise return a JSON SessionUrl. */
3009
3027
  redirect?: boolean;
3010
3028
  };
3011
3029
  export type PostV4PartnerByRouteApplicationIdStripeSubscriptionPortalApiResponse =
3012
- /** status 200 OK */ RandmarSubscriptionSession;
3030
+ /** status 200 Hosted session URL. Opening a session does not confirm a billing change. */ RandmarSubscriptionSession;
3013
3031
  export type PostV4PartnerByRouteApplicationIdStripeSubscriptionPortalApiArg = {
3032
+ /** Partner application ID identifying the reseller; requires authorization for this account. */
3014
3033
  routeApplicationId: string;
3034
+ /** When true, return HTTP 303 with the hosted URL in Location; otherwise return a JSON SessionUrl. */
3015
3035
  redirect?: boolean;
3016
3036
  };
3017
3037
  export type PostV4ResellerByRouteResellerIdReportHpAmplifiedEmailApiResponse = unknown;
@@ -3139,262 +3159,262 @@ export type PostV4ResellerByRouteResellerIdReportWalmartTrackingFileFileApiArg =
3139
3159
  };
3140
3160
  export type PostV4ManufacturerByRouteManufacturerIdReportReorderEmailApiResponse = unknown;
3141
3161
  export type PostV4ManufacturerByRouteManufacturerIdReportReorderEmailApiArg = {
3142
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3162
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3143
3163
  routeManufacturerId: string;
3144
- /** Recipient email (optional; if empty, sends to the authenticated user). Confirm before sending. */
3164
+ /** Query parameter. Recipient email address. When empty, the report service uses the authenticated caller’s email. */
3145
3165
  emailAddress?: string;
3146
3166
  };
3147
3167
  export type PostV4ManufacturerByRouteManufacturerIdReportResellersEmailApiResponse = unknown;
3148
3168
  export type PostV4ManufacturerByRouteManufacturerIdReportResellersEmailApiArg = {
3149
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3169
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3150
3170
  routeManufacturerId: string;
3151
- /** Recipient email (optional; if empty, sends to the authenticated user). Confirm before sending. */
3171
+ /** Query parameter. Recipient email address. When empty, the report service uses the authenticated caller’s email. */
3152
3172
  emailAddress?: string;
3153
3173
  };
3154
3174
  export type PostV4ManufacturerByRouteManufacturerIdReportReorderFileApiResponse = unknown;
3155
3175
  export type PostV4ManufacturerByRouteManufacturerIdReportReorderFileApiArg = {
3156
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3176
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3157
3177
  routeManufacturerId: string;
3158
3178
  };
3159
3179
  export type PostV4ManufacturerByRouteManufacturerIdReportReorderAndWarehouseLocationJsonApiResponse = unknown;
3160
3180
  export type PostV4ManufacturerByRouteManufacturerIdReportReorderAndWarehouseLocationJsonApiArg = {
3161
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3181
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3162
3182
  routeManufacturerId: string;
3163
- /** The warehouse location code (business/DC identifier) for the report. */
3183
+ /** Path parameter. The warehouse location code (business/DC identifier) for the report. */
3164
3184
  warehouseLocation: string;
3165
3185
  };
3166
3186
  export type PostV4ManufacturerByRouteManufacturerIdReportSalesEmailApiResponse = unknown;
3167
3187
  export type PostV4ManufacturerByRouteManufacturerIdReportSalesEmailApiArg = {
3168
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3188
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3169
3189
  routeManufacturerId: string;
3170
- /** Recipient email (optional; if empty, sends to the authenticated user). Confirm before sending. */
3190
+ /** Query parameter. Recipient email address. When empty, the report service uses the authenticated caller’s email. */
3171
3191
  emailAddress?: string;
3172
- /** Optional start date. Defaults to the first day of the current month if omitted. */
3192
+ /** Query parameter. Optional report start date. If omitted, uses the first day of the current server month. */
3173
3193
  startDate?: string;
3174
- /** Optional end date. Defaults to the first day of the current month if omitted. */
3194
+ /** Query parameter. Optional report end date. If omitted, also uses the first day of the current server month; supply explicit bounds for a full-month report. */
3175
3195
  endDate?: string;
3176
3196
  };
3177
3197
  export type PostV4ManufacturerByRouteManufacturerIdReportSalesAndResellerIdEmailApiResponse = unknown;
3178
3198
  export type PostV4ManufacturerByRouteManufacturerIdReportSalesAndResellerIdEmailApiArg = {
3179
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3199
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3180
3200
  routeManufacturerId: string;
3181
- /** The reseller application ID to scope the report. Resolve from the Resellers list. */
3201
+ /** Path parameter. The reseller application ID to scope the report. Resolve from the Resellers list. */
3182
3202
  resellerId: string;
3183
- /** Recipient email (optional; if empty, sends to the authenticated user). Confirm before sending. */
3203
+ /** Query parameter. Recipient email address. When empty, the report service uses the authenticated caller’s email. */
3184
3204
  emailAddress?: string;
3185
- /** Optional start date. Defaults to the first day of the current month if omitted. */
3205
+ /** Query parameter. Optional report start date. If omitted, uses the first day of the current server month. */
3186
3206
  startDate?: string;
3187
- /** Optional end date. Defaults to the first day of the current month if omitted. */
3207
+ /** Query parameter. Optional report end date. If omitted, also uses the first day of the current server month; supply explicit bounds for a full-month report. */
3188
3208
  endDate?: string;
3189
3209
  };
3190
3210
  export type PostV4ManufacturerByRouteManufacturerIdReportSalesFileApiResponse = unknown;
3191
3211
  export type PostV4ManufacturerByRouteManufacturerIdReportSalesFileApiArg = {
3192
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3212
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3193
3213
  routeManufacturerId: string;
3194
- /** Optional start date. Defaults to the first day of the current month if omitted. */
3214
+ /** Query parameter. Optional report start date. If omitted, uses the first day of the current server month. */
3195
3215
  startDate?: string;
3196
- /** Optional end date. Defaults to the first day of the current month if omitted. */
3216
+ /** Query parameter. Optional report end date. If omitted, also uses the first day of the current server month; supply explicit bounds for a full-month report. */
3197
3217
  endDate?: string;
3198
3218
  };
3199
3219
  export type PostV4ManufacturerByRouteManufacturerIdReportSalesJsonApiResponse = unknown;
3200
3220
  export type PostV4ManufacturerByRouteManufacturerIdReportSalesJsonApiArg = {
3201
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3221
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3202
3222
  routeManufacturerId: string;
3203
- /** Optional start date. Defaults to the first day of the current month if omitted. */
3223
+ /** Query parameter. Optional report start date. If omitted, uses the first day of the current server month. */
3204
3224
  startDate?: string;
3205
- /** Optional end date. Defaults to the first day of the current month if omitted. */
3225
+ /** Query parameter. Optional report end date. If omitted, also uses the first day of the current server month; supply explicit bounds for a full-month report. */
3206
3226
  endDate?: string;
3207
3227
  };
3208
3228
  export type PostV4ManufacturerByRouteManufacturerIdReportBestCanadianFulfillmentCentersApiResponse = unknown;
3209
3229
  export type PostV4ManufacturerByRouteManufacturerIdReportBestCanadianFulfillmentCentersApiArg = {
3210
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3230
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3211
3231
  routeManufacturerId: string;
3212
- /** Canadian postal codes. Codes longer than 7 characters are ignored. */
3232
+ /** JSON request body. Canadian postal codes. Codes longer than 7 characters are ignored. */
3213
3233
  body: string[];
3214
3234
  };
3215
3235
  export type PostV4ManufacturerByRouteManufacturerIdReportBestActiveCanadianFulfillmentCentersApiResponse = unknown;
3216
3236
  export type PostV4ManufacturerByRouteManufacturerIdReportBestActiveCanadianFulfillmentCentersApiArg = {
3217
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3237
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3218
3238
  routeManufacturerId: string;
3219
- /** Canadian postal codes. Codes longer than 7 characters are ignored. */
3239
+ /** JSON request body. Canadian postal codes. Codes longer than 7 characters are ignored. */
3220
3240
  body: string[];
3221
3241
  };
3222
3242
  export type PostV4ManufacturerByRouteManufacturerIdReportBestCanadianWarehousesApiResponse = unknown;
3223
3243
  export type PostV4ManufacturerByRouteManufacturerIdReportBestCanadianWarehousesApiArg = {
3224
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3244
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3225
3245
  routeManufacturerId: string;
3226
- /** Canadian postal codes. Codes longer than 7 characters are ignored. */
3246
+ /** JSON request body. Canadian postal codes. Codes longer than 7 characters are ignored. */
3227
3247
  body: string[];
3228
3248
  };
3229
3249
  export type PostV4ManufacturerByRouteManufacturerIdReportInventoryEmailApiResponse = unknown;
3230
3250
  export type PostV4ManufacturerByRouteManufacturerIdReportInventoryEmailApiArg = {
3231
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3251
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3232
3252
  routeManufacturerId: string;
3233
- /** Recipient email. Confirm before sending. */
3253
+ /** Query parameter. Recipient email address. When empty, the report service uses the authenticated caller’s email. */
3234
3254
  emailAddress?: string;
3235
- /** Inventory as-of date. Defaults to the current date if omitted. */
3255
+ /** Query parameter. Inventory as-of date. Defaults to the current date if omitted. */
3236
3256
  inventoryDate?: string;
3237
3257
  };
3238
3258
  export type PostV4ManufacturerByRouteManufacturerIdReportInventoryFileApiResponse = unknown;
3239
3259
  export type PostV4ManufacturerByRouteManufacturerIdReportInventoryFileApiArg = {
3240
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3260
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3241
3261
  routeManufacturerId: string;
3242
- /** Inventory as-of date. Defaults to the current date if omitted. */
3262
+ /** Query parameter. Inventory as-of date. Defaults to the current date if omitted. */
3243
3263
  inventoryDate?: string;
3244
3264
  };
3245
3265
  export type PostV4ManufacturerByRouteManufacturerIdReportInventoryJsonApiResponse = unknown;
3246
3266
  export type PostV4ManufacturerByRouteManufacturerIdReportInventoryJsonApiArg = {
3247
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3267
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3248
3268
  routeManufacturerId: string;
3249
- /** Inventory as-of date. Defaults to the current date if omitted. */
3269
+ /** Query parameter. Inventory as-of date. Defaults to the current date if omitted. */
3250
3270
  inventoryDate?: string;
3251
3271
  };
3252
3272
  export type PostV4ManufacturerByRouteManufacturerIdReportClaimEmailApiResponse = unknown;
3253
3273
  export type PostV4ManufacturerByRouteManufacturerIdReportClaimEmailApiArg = {
3254
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3274
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3255
3275
  routeManufacturerId: string;
3256
- /** Recipient email (required; no fallback). Confirm before sending. */
3276
+ /** Query parameter. Semicolon-separated recipient addresses. If omitted (null), uses subscribers to the manufacturer-claims notification; internal claim contacts are also copied. */
3257
3277
  emailAddress?: string;
3258
- /** Optional start date for the claim report. */
3278
+ /** Query parameter. Optional start date for the claim report. */
3259
3279
  startDate?: string;
3260
- /** Optional end date for the claim report. */
3280
+ /** Query parameter. Optional end date for the claim report. */
3261
3281
  endDate?: string;
3262
3282
  };
3263
3283
  export type PostV4ManufacturerByRouteManufacturerIdReportClaimFileApiResponse = unknown;
3264
3284
  export type PostV4ManufacturerByRouteManufacturerIdReportClaimFileApiArg = {
3265
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3285
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3266
3286
  routeManufacturerId: string;
3267
- /** Optional start date for the claim report. */
3287
+ /** Query parameter. Optional start date for the claim report. */
3268
3288
  startDate?: string;
3269
- /** Optional end date for the claim report. */
3289
+ /** Query parameter. Optional end date for the claim report. */
3270
3290
  endDate?: string;
3271
3291
  };
3272
3292
  export type PostV4ManufacturerByRouteManufacturerIdReportOpenOrdersEmailApiResponse = unknown;
3273
3293
  export type PostV4ManufacturerByRouteManufacturerIdReportOpenOrdersEmailApiArg = {
3274
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3294
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3275
3295
  routeManufacturerId: string;
3276
- /** Recipient email. Confirm before sending. */
3296
+ /** Query parameter. Recipient email address. When empty, the report service uses the authenticated caller’s email. */
3277
3297
  emailAddress?: string;
3278
3298
  };
3279
3299
  export type PostV4ManufacturerByRouteManufacturerIdReportOpenOrdersJsonApiResponse = unknown;
3280
3300
  export type PostV4ManufacturerByRouteManufacturerIdReportOpenOrdersJsonApiArg = {
3281
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3301
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3282
3302
  routeManufacturerId: string;
3283
- /** Unused by the service; you may pass an empty string. */
3303
+ /** Query parameter. Legacy unused query parameter; this action does not send an email. */
3284
3304
  emailAddress?: string;
3285
3305
  };
3286
3306
  export type PostV4ManufacturerByRouteManufacturerIdReportProductsEmailApiResponse = unknown;
3287
3307
  export type PostV4ManufacturerByRouteManufacturerIdReportProductsEmailApiArg = {
3288
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3308
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3289
3309
  routeManufacturerId: string;
3290
- /** Recipient email. Confirm before sending. */
3310
+ /** Query parameter. Recipient email address. When empty, the report service uses the authenticated caller’s email. */
3291
3311
  emailAddress?: string;
3292
3312
  };
3293
3313
  export type PostV4ManufacturerByRouteManufacturerIdReportProductsFileApiResponse = unknown;
3294
3314
  export type PostV4ManufacturerByRouteManufacturerIdReportProductsFileApiArg = {
3295
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3315
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3296
3316
  routeManufacturerId: string;
3297
3317
  };
3298
3318
  export type PostV4ManufacturerByRouteManufacturerIdReportProductsTsvApiResponse = unknown;
3299
3319
  export type PostV4ManufacturerByRouteManufacturerIdReportProductsTsvApiArg = {
3300
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3320
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3301
3321
  routeManufacturerId: string;
3302
3322
  };
3303
3323
  export type PostV4ManufacturerByRouteManufacturerIdReportProductsJsonApiResponse = unknown;
3304
3324
  export type PostV4ManufacturerByRouteManufacturerIdReportProductsJsonApiArg = {
3305
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3325
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3306
3326
  routeManufacturerId: string;
3307
3327
  };
3308
3328
  export type PostV4ManufacturerByRouteManufacturerIdReportPurchasedOrdersEmailApiResponse = unknown;
3309
3329
  export type PostV4ManufacturerByRouteManufacturerIdReportPurchasedOrdersEmailApiArg = {
3310
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3330
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3311
3331
  routeManufacturerId: string;
3312
- /** Recipient email. Confirm before sending. */
3332
+ /** Query parameter. Recipient email address. When empty, the report service uses the authenticated caller’s email. */
3313
3333
  emailAddress?: string;
3314
3334
  };
3315
3335
  export type PostV4ManufacturerByRouteManufacturerIdReportPurchasedOrdersFileApiResponse = unknown;
3316
3336
  export type PostV4ManufacturerByRouteManufacturerIdReportPurchasedOrdersFileApiArg = {
3317
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3337
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3318
3338
  routeManufacturerId: string;
3319
3339
  };
3320
3340
  export type DeleteV4ManufacturerByRouteManufacturerIdRequisitionAndRequisitionNumberApiResponse = unknown;
3321
3341
  export type DeleteV4ManufacturerByRouteManufacturerIdRequisitionAndRequisitionNumberApiArg = {
3322
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3342
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3323
3343
  routeManufacturerId: string;
3324
- /** The requisition number to cancel. Obtain from `GET .../Documents/Requisitions`. */
3344
+ /** Path parameter. The requisition number to cancel. Obtain from `GET .../Documents/Requisitions`. */
3325
3345
  requisitionNumber: string;
3326
3346
  };
3327
3347
  export type PostV4ManufacturerByRouteManufacturerIdRequisitionAndRequisitionNumberEditItemRandmarSkuApiResponse = unknown;
3328
3348
  export type PostV4ManufacturerByRouteManufacturerIdRequisitionAndRequisitionNumberEditItemRandmarSkuApiArg = {
3329
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3349
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3330
3350
  routeManufacturerId: string;
3331
- /** The requisition number to edit. Obtain from `GET .../Documents/Requisitions`. */
3351
+ /** Path parameter. The requisition number to edit. Obtain from `GET .../Documents/Requisitions`. */
3332
3352
  requisitionNumber: string;
3333
- /** The Randmar SKU to edit. */
3353
+ /** Path parameter. The Randmar SKU to edit. */
3334
3354
  randmarSku: string;
3335
- /** The new quantity (0 removes the item). */
3355
+ /** Query parameter. The new quantity (0 removes the item). */
3336
3356
  quantity?: number;
3337
3357
  };
3338
3358
  export type PutV4ManufacturerByRouteManufacturerIdRequisitionApiResponse =
3339
3359
  /** status 200 The requisition number of the newly created requisition. */ string;
3340
3360
  export type PutV4ManufacturerByRouteManufacturerIdRequisitionApiArg = {
3341
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3361
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3342
3362
  routeManufacturerId: string;
3343
- /** The requisition payload including location, reference, and part numbers with quantities. */
3363
+ /** JSON request body. The requisition payload including location, reference, and part numbers with quantities. */
3344
3364
  createRequisitionInput: CreateRequisitionInput;
3345
3365
  };
3346
3366
  export type GetV4ManufacturerByRouteManufacturerIdResellerAndResellerIdApiResponse =
3347
3367
  /** status 200 The requested reseller's information. */ Reseller;
3348
3368
  export type GetV4ManufacturerByRouteManufacturerIdResellerAndResellerIdApiArg = {
3349
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3369
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3350
3370
  routeManufacturerId: string;
3351
- /** The reseller application ID. Resolve from the Resellers list if the user gave a name. */
3371
+ /** Path parameter. The reseller application ID. Resolve from the Resellers list if the user gave a name. */
3352
3372
  resellerId: string;
3353
- /** Whether to include detailed specifications in the response. Defaults to true. */
3373
+ /** Query parameter. Whether to include detailed specifications in the response. Defaults to true. */
3354
3374
  withSpecification?: boolean;
3355
3375
  };
3356
3376
  export type GetV4ManufacturerByRouteManufacturerIdResellerAndResellerIdSalesStatisticsApiResponse =
3357
3377
  /** status 200 A list of sales statistics for the reseller. */ SalesStatistic[];
3358
3378
  export type GetV4ManufacturerByRouteManufacturerIdResellerAndResellerIdSalesStatisticsApiArg = {
3359
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3379
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3360
3380
  routeManufacturerId: string;
3361
- /** The reseller application ID whose sales statistics are requested. */
3381
+ /** Path parameter. The reseller application ID whose sales statistics are requested. */
3362
3382
  resellerId: string;
3363
- /** Optional start date for the statistics period. */
3383
+ /** Query parameter. Optional start date for the statistics period. */
3364
3384
  startDate?: string;
3365
- /** Optional end date for the statistics period. */
3385
+ /** Query parameter. Optional end date for the statistics period. */
3366
3386
  endDate?: string;
3367
3387
  };
3368
3388
  export type GetV4ManufacturerByRouteManufacturerIdResellerQualificationAndQualificationIdApiResponse =
3369
3389
  /** status 200 The requested reseller's information. */ Reseller;
3370
3390
  export type GetV4ManufacturerByRouteManufacturerIdResellerQualificationAndQualificationIdApiArg = {
3371
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3391
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3372
3392
  routeManufacturerId: string;
3373
- /** The qualification ID associated with the reseller. */
3393
+ /** Path parameter. The qualification ID associated with the reseller. */
3374
3394
  qualificationId: string;
3375
- /** Whether to include detailed specifications in the response. Defaults to false. */
3395
+ /** Query parameter. Whether to include detailed specifications in the response. Defaults to false. */
3376
3396
  withSpecification?: boolean;
3377
3397
  };
3378
3398
  export type PutV4ManufacturerByRouteManufacturerIdResellerAndResellerIdQualificationApiResponse = unknown;
3379
3399
  export type PutV4ManufacturerByRouteManufacturerIdResellerAndResellerIdQualificationApiArg = {
3380
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3400
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3381
3401
  routeManufacturerId: string;
3382
- /** The reseller application ID to qualify. Resolve from the Resellers list if needed. */
3402
+ /** Path parameter. The reseller application ID to qualify. Resolve from the Resellers list if needed. */
3383
3403
  resellerId: string;
3384
- /** The qualification value to assign. */
3404
+ /** Query parameter. The qualification value to assign. */
3385
3405
  newValue?: string;
3386
3406
  };
3387
3407
  export type DeleteV4ManufacturerByRouteManufacturerIdResellerAndResellerIdQualificationApiResponse = unknown;
3388
3408
  export type DeleteV4ManufacturerByRouteManufacturerIdResellerAndResellerIdQualificationApiArg = {
3389
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3409
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3390
3410
  routeManufacturerId: string;
3391
- /** The reseller application ID whose qualification will be removed. */
3411
+ /** Path parameter. The reseller application ID whose qualification will be removed. */
3392
3412
  resellerId: string;
3393
3413
  };
3394
3414
  export type GetV4ManufacturerByRouteManufacturerIdResellersApiResponse =
3395
3415
  /** status 200 A list of resellers. */ Reseller[];
3396
3416
  export type GetV4ManufacturerByRouteManufacturerIdResellersApiArg = {
3397
- /** The target manufacturer's application ID. Admins must pass the manufacturer ID, not HQ. */
3417
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3398
3418
  routeManufacturerId: string;
3399
3419
  };
3400
3420
  export type GetV4AgencyByRouteAgencyIdResellersApiResponse =
@@ -3402,13 +3422,15 @@ export type GetV4AgencyByRouteAgencyIdResellersApiResponse =
3402
3422
  export type GetV4AgencyByRouteAgencyIdResellersApiArg = {
3403
3423
  /** The target agency application ID. Not HQ IDs such as `2` or `FGDCT3037`. Resolve partner/agency names via `GET V4/Intranet/Search/Partners`. */
3404
3424
  routeAgencyId: string;
3405
- /** Whether to include detailed specifications for each reseller. Defaults to false. */
3425
+ /** Query flag, false by default. True adds SalesData and agency information, including the reseller association's ProgramPercentage. */
3406
3426
  withSpecification?: boolean;
3407
3427
  };
3408
3428
  export type GetV4ResellerByRouteResellerIdReturnAndReturnNumberApiResponse =
3409
- /** status 200 OK */ ReturnOld;
3429
+ /** status 200 Return details and related records. */ ReturnOld;
3410
3430
  export type GetV4ResellerByRouteResellerIdReturnAndReturnNumberApiArg = {
3431
+ /** Target reseller application ID. */
3411
3432
  routeResellerId: string;
3433
+ /** Return number to retrieve within that reseller's account. */
3412
3434
  returnNumber: string;
3413
3435
  };
3414
3436
  export type PostV4ResellerByRouteResellerIdReturnCreateApiResponse = unknown;
@@ -3435,8 +3457,11 @@ export type PutV4ResellerByRouteResellerIdReturnAndReturnNumberManufacturerRmaAp
3435
3457
  };
3436
3458
  export type PostV4ResellerByRouteResellerIdReturnAndReturnNumberAddCommentApiResponse = unknown;
3437
3459
  export type PostV4ResellerByRouteResellerIdReturnAndReturnNumberAddCommentApiArg = {
3460
+ /** Target reseller application ID. */
3438
3461
  routeResellerId: string;
3462
+ /** Return number belonging to the reseller. */
3439
3463
  returnNumber: string;
3464
+ /** Comment text supplied as a query parameter. */
3440
3465
  comment?: string;
3441
3466
  };
3442
3467
  export type PostV4ResellerByRouteResellerIdReturnAndReturnNumberRandmarSkuEditReasonApiResponse = unknown;
@@ -3491,7 +3516,7 @@ export type PostV4ResellerByRouteResellerIdReturnAndReturnNumberCreditApiRespons
3491
3516
  export type PostV4ResellerByRouteResellerIdReturnAndReturnNumberCreditApiArg = {
3492
3517
  /** The return number to be credited. */
3493
3518
  returnNumber: string;
3494
- /** The optional credit document number to associate with this credit. */
3519
+ /** Required existing credit document number: exactly eight characters beginning with CN. */
3495
3520
  creditNumber?: string;
3496
3521
  routeResellerId: string;
3497
3522
  };
@@ -3505,7 +3530,7 @@ export type PostV4ResellerByRouteResellerIdReturnAndReturnNumberDeclineApiArg =
3505
3530
  reason?: string;
3506
3531
  };
3507
3532
  export type PutV4ResellerByRouteResellerIdReturnAndReturnNumberAdminCreditApiResponse =
3508
- /** status 200 Returns a result object indicating success. */ string;
3533
+ /** status 200 Created credit document number. The return is linked and marked Credited; credit-email failures do not roll back the credit. */ string;
3509
3534
  export type PutV4ResellerByRouteResellerIdReturnAndReturnNumberAdminCreditApiArg = {
3510
3535
  /** The return number to be credited. */
3511
3536
  returnNumber: string;
@@ -3559,7 +3584,7 @@ export type GetV4ResellerByRouteResellerIdReturnsApiArg = {
3559
3584
  export type GetV4ManufacturerByRouteManufacturerIdReturnsApiResponse =
3560
3585
  /** status 200 A list of returns. */ ReturnOld[];
3561
3586
  export type GetV4ManufacturerByRouteManufacturerIdReturnsApiArg = {
3562
- /** The ID of the manufacturer making the request. */
3587
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3563
3588
  routeManufacturerId: string;
3564
3589
  };
3565
3590
  export type GetV4ShopifyByShopifyHostNameSearchApiResponse =
@@ -3567,7 +3592,7 @@ export type GetV4ShopifyByShopifyHostNameSearchApiResponse =
3567
3592
  export type GetV4ShopifyByShopifyHostNameSearchApiArg = {
3568
3593
  /** The host name of the Shopify store (e.g., 'your-store.myshopify.com'). */
3569
3594
  shopifyHostName: string;
3570
- /** The search query string. */
3595
+ /** URL-encoded query text; use at least three characters for catalog searching. */
3571
3596
  q?: string;
3572
3597
  };
3573
3598
  export type GetV4ResellerByRouteResellerIdSearchApiResponse =
@@ -3587,11 +3612,11 @@ export type GetV4PartnerByRouteApplicationIdSearchApiArg = {
3587
3612
  q?: string;
3588
3613
  };
3589
3614
  export type GetV4ManufacturerByRouteManufacturerIdSearchApiResponse =
3590
- /** status 200 An array of search results matching the query. */ SearchResult;
3615
+ /** status 200 A JSON array of typed search hits; an empty array when the manufacturer is unavailable, the query is too short, or no matches are found. */ SearchResult;
3591
3616
  export type GetV4ManufacturerByRouteManufacturerIdSearchApiArg = {
3592
- /** The application ID of the Manufacturer making the request. */
3617
+ /** Path parameter. Target manufacturer application ID; this identifies the manufacturer being accessed, not the caller’s application. */
3593
3618
  routeManufacturerId: string;
3594
- /** The search query string (e.g., order number, reseller name, product SKU). */
3619
+ /** Query parameter. Search query, at least three characters. Supports recognized PO/RCP/RQN numbers and general reseller, product, or opportunity terms. */
3595
3620
  s?: string;
3596
3621
  };
3597
3622
  export type PutV4ResellerByRouteResellerIdShippingLabelGenerateApiResponse =
@@ -4150,6 +4175,7 @@ export type DeleteV4PartnerByRouteApplicationIdWorkflowProjectAndProjectIdTaskTa
4150
4175
  };
4151
4176
  export type PutV4PartnerByRouteApplicationIdWorkflowAssistantTaskApiResponse = unknown;
4152
4177
  export type PutV4PartnerByRouteApplicationIdWorkflowAssistantTaskApiArg = {
4178
+ /** Partner application whose workflows the queued assistant should process. */
4153
4179
  routeApplicationId: string;
4154
4180
  };
4155
4181
  export type PostV4PartnerByRouteApplicationIdWorkflowProjectAndProjectIdTaskTaskIdStandardOperatingProcedureSopIdApiResponse = unknown;