--- schema_version: "1" id: 52420fe166a5fb278a13a4c6ace432f83ba1f971c3f82a1f116f8264cb0ccde4 title: Promotion Management API collection: developer version: current locale: en-us portal_url: https://docs.salesforce.com/developer/current/en-us/commerce-cloud/retail-cloud/reference/generated-api-specs/promotion-management-api.md canonical_url: https://developer.salesforce.com/docs/commerce/retail-cloud/references/promotion-management-api source_site: developer.salesforce.com content_type: documentation content_hash: 0b72040da128e308900c1ed399ac1fcf874c01bca6a52695d332bd948493d5a7 products: - Point of Sale for Developers - Salesforce APIs --- Promotion Management API # Promotion Management API [Download specification](https://developer.salesforce.com/static/commercecloud/retail-cloud/promotion-management-api/promotion-management-api-oas-public.yaml) POS Merchant API to perform CRUD operations on promotions in the POS system. **Version:** 2.3.4 ## Tags ### Promotion Management API [Download specification](https://developer.salesforce.com/static/commercecloud/retail-cloud/promotion-management-api/promotion-management-api-oas-public.yaml) POS Merchant API to perform CRUD operations on promotions in the POS system. ## Operations ### GET Promotion management - get promotions `GET /merchant/{version}/promotions` Operation ID: `getPromotions`. Tags: Promotion Management API. Retrieve promotions by ID, status, channel, or promotion code. #### Parameters * `PredictSpring-Secret` (header, string) * `version` (path, string, required) Supported: v1. Pattern: v1|v2. * `promotionId` (query, string) * `active` (query, boolean) * `availableType` (query, string) Allowed values: `EXPIRED`, `NOW`, `FUTURE`. * `channel` (query, string) * `promoCode` (query, string) #### Responses * **default** Default response. Media type: `application/json`. Schema: `array of Promotion`. Array of `Promotion`. ### PUT Promotion management - Create or update promotion `PUT /merchant/{version}/promotions` Operation ID: `updatePromotion`. Tags: Promotion Management API. The request must include all properties of a promotion for the upsert operation to succeed. #### Parameters * `PredictSpring-Secret` (header, string) * `version` (path, string, required) Supported: v1. Pattern: v1|v2. #### Request body Media type: `application/json`. Schema: `Promotion`. #### Responses * **default** Default response. Media type: `application/json`. Schema: `Promotion`. ### POST Create or update promotion. `POST /merchant/{version}/promotions` Operation ID: `addPromotion`. Tags: Promotion Management API. Create or update a promotion. The request must include all properties of a promotion so that the upsert operation succeeds. #### Parameters * `PredictSpring-Secret` (header, string) * `version` (path, string, required) Supported: v1. Pattern: v1|v2. #### Request body Media type: `application/json`. Schema: `Promotion`. #### Responses * **default** Default response. Media type: `application/json`. Schema: `Promotion`. ### PATCH Update promotions. `PATCH /merchant/{version}/promotions` Operation ID: `patchPromotions`. Tags: Promotion Management API. Update promotions. The request can include any property of a promotion, but must include the promotion ID so that the update can be performed. **Limit:** 100 promotions per request. #### Parameters * `PredictSpring-Secret` (header, string) * `version` (path, string, required) Supported: v1. Pattern: v1|v2. #### Request body Media type: `application/json`. Schema: `UpdatePromotionsRequest`. #### Responses * **default** Default response. Media type: `application/json`. Schema: `UpdatePromotionsResponse`. ### GET Get promotion. `GET /merchant/{version}/promotions/{promotionId}` Operation ID: `getPromotion`. Tags: Promotion Management API. Retrieve a promotion. #### Parameters * `PredictSpring-Secret` (header, string) * `version` (path, string, required) Supported: v1. Pattern: v1|v2. * `promotionId` (path, string, required) #### Responses * **default** Default response. Media type: `application/json`. Schema: `Promotion`. ### DELETE Delete promotion. `DELETE /merchant/{version}/promotions/{promotionId}` Operation ID: `deletePromotion`. Tags: Promotion Management API. Delete a promotion. #### Parameters * `version` (path, string, required) Supported: v1. Pattern: v1|v2. * `promotionId` (path, string, required) #### Responses * **default** Default response. Media type: `application/json`. Schema: `PSResponse`. ### GET Download promotions report. `GET /merchant/{version}/promotions/download/report` Operation ID: `downloadPromotions`. Tags: Promotion Management API. Download a report of promotions. #### Parameters * `PredictSpring-Secret` (header, string) * `version` (path, string, required) Supported: v1. Pattern: v1|v2. * `promotionId` (query, string) * `active` (query, boolean) * `channel` (query, string) * `promoCode` (query, string) #### Responses * **default** Default response. Media type: `application/json`. Schema: `DownloadFileResponse`. ### GET Get promotion codes. `GET /merchant/{version}/promotions/{promotionId}/supc` Operation ID: `getOneTimePromotionCode`. Tags: Promotion Management API. Retrieve a list of Single Use Promotion Codes (SUPC) in a promotion from the POS. #### Parameters * `PredictSpring-Secret` (header, string) * `version` (path, string, required) Supported: v1. Pattern: v1|v2. * `promotionId` (path, string, required) * `promotionCode` (query, string) * `redeem` (query, boolean) * `start` (query, integer (int32)) * `limit` (query, integer (int32)) #### Responses * **default** Default response. Media type: `application/json`. Schema: `PageOneTimePromotionCodeResponse`. ### PUT Update one-time promotion codes. `PUT /merchant/{version}/promotions/{promotionId}/supc` Operation ID: `updateOneTimePromotionCode`. Tags: Promotion Management API. Update the redemption status of SUPCs in a promotion that were redeemed by an external system. #### Parameters * `PredictSpring-Secret` (header, string) * `version` (path, string, required) Supported: v1. Pattern: v1|v2. * `promotionId` (path, string, required) * `redeem` (query, boolean) #### Request body Media type: `application/json`. Schema: `UpsertOneTimePromotionRequest`. #### Responses * **default** Default response. Media type: `application/json`. Schema: `OneTimeCodeDataUploadResult`. ### POST Insert one-time promotion codes. `POST /merchant/{version}/promotions/{promotionId}/supc` Operation ID: `insertOneTimePromotionCode`. Tags: Promotion Management API. Create and send new valid SUPCs in a promotion to the POS system. #### Parameters * `PredictSpring-Secret` (header, string) * `version` (path, string, required) Supported: v1. Pattern: v1|v2. * `promotionId` (path, string, required) #### Request body Media type: `application/json`. Schema: `UpsertOneTimePromotionRequest`. #### Responses * **default** Default response. Media type: `application/json`. Schema: `OneTimeCodeDataUploadResult`. ### GET Retrieve promotions. `GET /merchant/{version}/promotions/pagination` Operation ID: `getPromotionsPagination`. Tags: Promotion Management API. Retrieve a list of promotions based on the provided query parameters. The parameters include: 1. `promotionId`: A query parameter to filter promotions by ID. (Optional) 2. `active`: A query parameter to filter promotions by their active status. (Optional) 3. `availableType`: A query parameter to filter promotions by their availability type. (Optional) 4. `channel`: A query parameter to filter promotions by channel. (Optional) 5. `promoCode`: A query parameter to filter promotions by promo code. (Optional) 6. `start`: A query parameter with a default value of 0, indicating the starting point for pagination. 7. `limit`: A query parameter with a default value of 200, indicating the maximum number of promotions to return. **Note:** Due to API Gateway limitations, responses exceeding 10MB will result in a 500 error. #### Parameters * `version` (path, string, required) Supported: v1. Pattern: v1|v2. * `promotionId` (query, string) * `active` (query, boolean) * `availableType` (query, string) Allowed values: `EXPIRED`, `NOW`, `FUTURE`. * `channel` (query, string) * `promoCode` (query, string) * `start` (query, integer (int32)) Default: `0`. * `limit` (query, integer (int32)) Default: `200`. #### Responses * **default** Default response. Media type: `application/json`. Schema: `GetPromotionsResponse`. ### POST Look up one-time promotion codes. `POST /merchant/{version}/promotions/supc/lookup` Operation ID: `oneTimePromotionCodeLookup`. Tags: Promotion Management API. Return information about one-time promotion codes based on input codes. The maximum size of an input list is 100. #### Parameters * `PredictSpring-Secret` (header, string) * `version` (path, string, required) Supported: v1. Pattern: v1|v2. #### Responses * **default** Default response. Media type: `application/json`. Schema: `OneTimePromotionCodeLookupResponse`. ### POST Upload promotion by JSON file. `POST /merchant/{version}/promotions/upload` Operation ID: `uploadPromotionByJsonFile`. Tags: Promotion Management API. Upload a promotion by JSON file. Refer to [Single-Use Promotion Code](https://developer.salesforce.com/docs/commerce/retail-cloud/guide/single-use-promotion-code.html) for file specification. #### Parameters * `PredictSpring-Secret` (header, string) * `version` (path, string, required) Supported: v1. Pattern: v1|v2. #### Request body Media type: `multipart/form-data`. Schema: `object`. * `File` (_FormDataBodyPart_) #### Responses * **default** Default response. Media type: `application/json`. Schema: `PromotionFileUploadResponse`. ## Schemas ### Promotion * `merchantId` (_string_) * `locale` (_string_) * `region` (_string_) * `promotionId` (_string_) * `name` (_string_) * `title` (_string_) * `description` (_string_) * `promoCode` (_string_) * `inStorePromoCode` (_string_) * `appPromoCode` (_string_) * `onlinePromoCode` (_string_) * `outletPromoCode` (_string_) * `promoFeedSource` (_FeedSource_) * `startTimeStamp` (_integer (int64)_) * `endTimeStamp` (_integer (int64)_) * `combinationTypes` (_array of string_) * `channel` (_array of string_) Items: Allowed values: `ALL`, `WEB`, `APP`, `STORE`, `OUTLET`. * `priorityOrder` (_integer (int32)_) * `active` (_boolean_) * `auto` (_boolean_) * `redemptionLimit` (_number (double)_) * `uniqueCodeUrl` (_string_) * `redeems` (_number (double)_) * `barCodeType` (_string_) * `promotionType` (_string_) Allowed values: `ORDER_PERCENT_OFF`, `ORDER_AMOUNT_OFF`, `FREE_SHIPPING`, `BXGY`, `FREE_SAMPLES`, `X_FOR_Y`, `PRODUCT_FIXED_AMOUNT`, `FREE_SHIPPING_V2`. * `percentOff` (_number (double)_) * `maxDiscountAmount` (_number (double)_) * `maxTotal` (_number_) * `amountOff` (_number_) * `shippingMethods` (_array of string_) * `hasSingleUsePromoCodes` (_boolean_) * `imageUrl` (_string_) * `discountedQuantity` (_integer (int32)_) * `freeSamples` (_array of CombinationGroup_) * `merchantPromotionId` (_string_) * `amount` (_number_) * `promoRules` (_array of PromotionRule_) * `qualifyingGroups` (_array of CombinationGroup_) * `discountedGroups` (_array of CombinationGroup_) * `amountExpression` (_string_) * `tierGroups` (_array of TierGroup_) * `discountedGroupProration` (_boolean_) * `promotionLanguageData` (_array of PromotionLanguageData_) Promotion attributes in additional languages. * `bxgyDiscountType` (_string_) Buy X Get Y discount types. Allowed values: `PERCENT_OFF`, `AMOUNT_OFF`, `FIXED_PRICE`. * `createdBy` (_string_) * `createdOn` (_string (date-time)_) * `lastUpdatedOn` (_string (date-time)_) * `lastUpdatedBy` (_string_) * `promotionMappings` (_array of PromotionMapping_) * `isExternallyValidated` (_boolean_) * `promotionTypePriority` (_string_) Allowed values: `FREE_SAMPLES`, `BXGY_FIXED_AMOUNT`, `X_FOR_Y`, `BXGY_AMOUNT_OFF`, `BXGY_PERCENT_OFF`, `PRODUCT_FIXED_AMOUNT`, `ORDER_AMOUNT_OFF`, `ORDER_PERCENT_OFF`, `FREE_SHIPPING_V2`, `FREE_SHIPPING`. * `promotionCode` (_PromotionCode_) ### UpdatePromotionsRequest * `promotions` (_array of Promotion_) ### UpdatePromotionsResponse * `errorMessage` (_string_, nullable) Error message shown to the user. Example: `Invalid request. Please check the request and try again.`. * `errorCode` (_string_, nullable) Error code shown to the user. Example: `INTERNAL_ERROR`. * `promotions` (_array of Promotion_) * `error` (_boolean_) ### PSResponse * `errorMessage` (_string_, nullable) Error message shown to the user. Example: `Invalid request. Please check the request and try again.`. * `errorCode` (_string_, nullable) Error code shown to the user. Example: `INTERNAL_ERROR`. * `error` (_boolean_) ### DownloadFileResponse * `status` (_string_) * `statusMessage` (_string_) * `fileName` (_string_) * `url` (_string (url)_) ### PageOneTimePromotionCodeResponse * `totalPages` (_integer (int32)_) * `totalElements` (_integer (int64)_) * `pageable` (_Pageable_) * `numberOfElements` (_integer (int32)_) * `first` (_boolean_) * `number` (_integer (int32)_) * `size` (_integer (int32)_) * `content` (_array of OneTimePromotionCodeResponse_) * `sort` (_Sort_) * `last` (_boolean_) * `empty` (_boolean_) ### UpsertOneTimePromotionRequest * `promotionCodes` (_array of PromotionCode_) List of one-time promotion entities. ### OneTimeCodeDataUploadResult * `unprocessedCodes` (_array of OneTimePromotionCodeUpsertVO_) * `totalProcessed` (_integer (int32)_) * `totalError` (_integer (int32)_) * `entriesUpdated` (_integer (int32)_) * `entriesInactive` (_integer (int32)_) * `errors` (_array of object_) * `cause` (_object_) * `stackTrace` (_array of object_) * `classLoaderName` (_string_) * `moduleName` (_string_) * `moduleVersion` (_string_) * `methodName` (_string_) * `fileName` (_string_) * `lineNumber` (_integer (int32)_) * `nativeMethod` (_boolean_) * `className` (_string_) * `message` (_string_) * `localizedMessage` (_string_) * `stackTrace` (_array of object_) * `classLoaderName` (_string_) * `moduleName` (_string_) * `moduleVersion` (_string_) * `methodName` (_string_) * `fileName` (_string_) * `lineNumber` (_integer (int32)_) * `nativeMethod` (_boolean_) * `className` (_string_) * `message` (_string_) * `suppressed` (_array of object_) * `stackTrace` (_array of object_) * `classLoaderName` (_string_) * `moduleName` (_string_) * `moduleVersion` (_string_) * `methodName` (_string_) * `fileName` (_string_) * `lineNumber` (_integer (int32)_) * `nativeMethod` (_boolean_) * `className` (_string_) * `message` (_string_) * `localizedMessage` (_string_) * `localizedMessage` (_string_) * `processedFile` (_DataFeedFile_) ### GetPromotionsResponse * `totalCount` (_integer (int64)_) The total number of promotions available. * `promotions` (_array of Promotion_) A list of promotions returned in the response. ### OneTimePromotionCodeLookupResponse * `errorMessage` (_string_, nullable) Error message shown to the user. Example: `Invalid request. Please check the request and try again.`. * `errorCode` (_string_, nullable) Error code shown to the user. Example: `INTERNAL_ERROR`. * `totalCount` (_integer (int32)_) * `oneTimePromotionCodeResponse` (_array of OneTimePromotionCodeResponse_) * `error` (_boolean_) ### FormDataBodyPart * `contentDisposition` (_ContentDisposition_) * `entity` (_object_) * `headers` (_object_) * `empty` (_boolean_) Additional properties: `array of string`. * `mediaType` (_MediaType_) * `messageBodyWorkers` (_MessageBodyWorkers_) * `parent` (_MultiPart_) * `providers` (_Providers_) * `formDataContentDisposition` (_FormDataContentDisposition_) * `simple` (_boolean_) * `name` (_string_) * `value` (_string_) * `content` (_object_) * `fileName` (_string_) * `parameterizedHeaders` (_object_) * `empty` (_boolean_) Additional properties: `array of ParameterizedHeader`. ### PromotionFileUploadResponse * `statuses` (_array of PromotionUploadStatus_) List of promotion status. * `successCount` (_integer (int32)_) Number of successfully uploaded promotions. * `count` (_integer (int32)_) Number of total promotions. ### FeedSource * `feedType` (_string_) Allowed values: `PRODUCT`, `PRODUCT_BUNDLE`, `STORE`, `LAYOUT`, `PRODUCT_PROMOTION`, `PRODUCT_CATEGORY`, `PRODUCT_CATEGORY_PROMOTION`, `PROMOTION`, `STORE_INVENTORY_FULL`, `STORE_INVENTORY_DELTA`, `SOCIAL_MEDIA`, `ONE_TIME_PROMOTION_CODE`, `PRODUCT_DELTA`, `CATEGORY`, `ORDER_LIST`, `ORDER_DETAILS`, `RECOMMENDATION`, `TAX_RATE`, `PIPELINE`, `STORE_ASSOCIATES`, `PREDICTSPRING_PROMOTION`, `REWARD`, `CASH_REWARD`, `ASN`, `CORP_TRANSFER`, `POS_PROVISIONING`, `SYNONYM`, `STORE_AREA_GOAL`, `STORE_AREA_HIERARCHY`, `OMS`, `PRODUCT_PRICING`, `PRODUCT_SIZING`, `PRODUCT_INVENTORY`, `PRODUCT_PRICING_DELTA`, `PRODUCT_SIZING_DELTA`, `PRODUCT_INVENTORY_DELTA`, `STORE_DEVICE`, `BOPIS_CANCEL_ORDER`, `PURCHASE_ORDER`, `OFFLINE_PROMOTION`, `PREDICTSPRING_PROMOTION_V2`, `EXPIRED_PAYMENT_LINK_CLEANUP`, `SINGLE_USE_PROMO_CODES`, `STORE_GROUP_FULL`, `STORE_GROUP_DELTA`. * `feedSourceName` (_string_) * `feedSourceType` (_string_) Allowed values: `URL`, `SFTP`, `FTP`, `S3`, `YEXT`, `AVALARA`, `SABRIX`, `AVALARA_V2`, `VERTEX`, `SPI`, `WEBDAV`. * `fileNames` (_array of string_) * `feedFileType` (_string_) Allowed values: `CSV`, `TSV`, `SSV`, `PSV`, `XML`, `STORE_XML`, `INVENTORY_XML`, `JSON`, `YEXT`, `ASN_EDI_856`, `OTHER`. * `feedPreprocessorClass` (_string_) * `feedFileMetadataList` (_array of FeedFileMetadata_) * `baseURL` (_string_) * `urlRequestParams` (_string_) * `folderName` (_string_) * `host` (_string_) * `port` (_integer (int32)_) * `userName` (_string_) * `password` (_string_) * `s3FeedTimestamp` (_integer (int64)_) * `parentTag` (_string_) * `multiValueFieldList` (_array of string_) * `preserveIfNullFieldList` (_array of string_) * `currencyCode` (_string_) * `idColumn` (_string_) * `multiValueFieldDelimiter` (_string_) * `columnNames` (_string_) * `promotionId` (_string_) * `deleteFeed` (_boolean_) * `addFeed` (_boolean_) * `updateFeed` (_boolean_) * `fullFeed` (_boolean_) * `sourceEncoding` (_string_) * `maxRecordsToProcess` (_integer (int32)_) * `apiKey` (_string_) * `version` (_string_) * `categoryProductRankColumnName` (_string_) * `productIdFieldName` (_string_) * `feedName` (_string_) * `feedDescription` (_string_) * `isProductBundleCategorySource` (_boolean_) * `importPromotions` (_boolean_) * `hasCategories` (_boolean_) * `shouldProcessCategoryCounts` (_boolean_) * `skipFields` (_string_) * `hasProductMultiPromotions` (_boolean_) * `fieldDelimiter` (_string_) * `endLineDelimiter` (_string_) * `deviceOS` (_string_) * `dataSource` (_string_) Allowed values: `NETSUITE`. * `accountId` (_string_) * `licenseKey` (_string_) * `merchantReferenceCode` (_string_) * `bulkProcessing` (_boolean_) * `backUp` (_boolean_) * `continueOnFileError` (_boolean_) * `clientId` (_string_) * `clientSecret` (_string_) * `hasActualInventoryCount` (_boolean_) * `oauthHost` (_string_) ### CombinationGroup Products that receive the discount when the qualifying condition is met. * `quantity` (_integer (int32)_) * `quantityOperator` (_string_) Allowed values: `EQL`, `GTE`. * `productRules` (_array of PromotionRule_) ### PromotionRule Promotion rule provides the filtering criteria to determine if the order is eligible for promotion. * `promotionRuleId` (_string_) * `promotionId` (_string_) * `operator` (_string_, nullable) Operation to be performed for the rule depending on the value types. Allowed values: `DOES_NOT_CONTAIN`, `CONTAINS`, `GTE`, `LTE`, `EXISTS`, `NOT_EXISTS`. * `value` (_array of string_, nullable) Values are based on the value Types. They contain a list and for single value attributes use a list of size 1. Unique items. * `valueType` (_string_, nullable) Value Type provides the type of value. ### TierGroup * `amountExpression` (_string_) * `tierRules` (_array of PromotionRule_) * `id` (_string_) * `selectedProducts` (_array of string_) ### PromotionLanguageData Promotion attributes in additional languages. * `promotionId` (_string_) * `language` (_string_) The language/locale of properties for this object. * `name` (_string_) The name used for internal identification of the promotion. This field can also be used to assign a locale/language-specific name for the promotion. * `title` (_string_) The locale/language-specific title used for external display of the promotion on the presentation layer. * `description` (_string_) The locale/language-specific description used for external display of the promotion on the presentation layer. This contains the disclaimer and other information. ### PromotionMapping * `quantityOperator` (_string_) Allowed values: `EQL`, `GTE`. * `merchantId` (_string_) * `type` (_string_) Allowed values: `QUALIFYING_GROUP`, `DISCOUNTED_GROUP`, `TIER_GROUP`, `FREE_SAMPLES`. * `promotionRulesGroupId` (_string_) * `promotionMappingId` (_string_) * `promotionId` (_string_) * `amountExpression` (_string_) * `quantity` (_integer (int32)_) * `locale` (_string_) * `region` (_string_) ### PromotionCode * `merchantId` (_string_) * `region` (_string_) * `promotionId` (_string_) * `oneTimeCode` (_string_) * `oneTimeCodeCS` (_string_) * `codeType` (_string_) * `externalId` (_string_) * `codeAssignedDate` (_string (date-time)_) * `codeRedeemed` (_boolean_) * `codeRedeemedDate` (_string (date-time)_) * `storeCode` (_string_) * `promotionValidDate` (_string (date-time)_) * `type` (_string_) * `message` (_string_) * `validFrom` (_string (date-time)_) * `validTo` (_string (date-time)_) * `updatedOn` (_string (date-time)_) ### Pageable * `pageSize` (_integer (int32)_) * `pageNumber` (_integer (int32)_) * `paged` (_boolean_) * `unpaged` (_boolean_) * `offset` (_integer (int64)_) * `sort` (_Sort_) ### OneTimePromotionCodeResponse * `oneTimeCode` (_string_) * `status` (_string_) Allowed values: `VALID`, `REDEEMED`, `NOT_FOUND`. * `promoName` (_string_) * `promotionId` (_string_) * `orderId` (_string_) * `codeRedeemedDate` (_integer (int64)_) * `storeId` (_string_) ### Sort * `unsorted` (_boolean_) * `sorted` (_boolean_) * `empty` (_boolean_) ### OneTimePromotionCodeUpsertVO * `errorMessage` (_string_) * `errorCode` (_string_) * `oneTimePromotionCode` (_string_) ### DataFeedFile * `dataStream` (_object_) * `fileName` (_string_) * `originalFileName` (_string_) * `length` (_integer (int64)_) * `contentType` (_string_) * `s3Reference` (_string_) ### ContentDisposition * `type` (_string_) * `parameters` (_object_) Additional properties: `string`. * `fileName` (_string_) * `creationDate` (_string (date-time)_) * `modificationDate` (_string (date-time)_) * `readDate` (_string (date-time)_) * `size` (_integer (int64)_) ### MediaType * `type` (_string_) * `subtype` (_string_) * `parameters` (_object_) Additional properties: `string`. * `wildcardType` (_boolean_) * `wildcardSubtype` (_boolean_) ### MessageBodyWorkers ### MultiPart * `contentDisposition` (_ContentDisposition_) * `entity` (_object_) * `headers` (_object_) * `empty` (_boolean_) Additional properties: `array of string`. * `mediaType` (_MediaType_) * `messageBodyWorkers` (_MessageBodyWorkers_) * `parent` (_MultiPart_) * `providers` (_Providers_) * `bodyParts` (_array of BodyPart_) * `parameterizedHeaders` (_object_) * `empty` (_boolean_) Additional properties: `array of ParameterizedHeader`. ### Providers ### FormDataContentDisposition * `type` (_string_) * `parameters` (_object_) Additional properties: `string`. * `fileName` (_string_) * `creationDate` (_string (date-time)_) * `modificationDate` (_string (date-time)_) * `readDate` (_string (date-time)_) * `size` (_integer (int64)_) * `name` (_string_) ### ParameterizedHeader * `value` (_string_) * `parameters` (_object_) Additional properties: `string`. ### PromotionUploadStatus List of promotion status. * `promotionId` (_string_) The ID of the promotion passed by CMS. * `status` (_string_) The upload status of the related promotion ID: Success or Failure. Allowed values: `SUCCESS`, `FAILURE`. * `exception` (_string_) Exception messages. * `promotionTitle` (_string_) The title of the promotion. * `errors` (_array of string_) List of errors. ### FeedFileMetadata * `fileName` (_string_) * `feedFileType` (_string_) Allowed values: `CSV`, `TSV`, `SSV`, `PSV`, `XML`, `STORE_XML`, `INVENTORY_XML`, `JSON`, `YEXT`, `ASN_EDI_856`, `OTHER`. * `feedPreprocessorClass` (_string_) * `parentTag` (_string_) * `multiValueFieldList` (_array of string_) * `preserveIfNullFieldList` (_array of string_) * `idColumn` (_string_) * `multiValueFieldDelimiter` (_string_) * `columnNames` (_string_) * `sourceEncoding` (_string_) ### BodyPart * `contentDisposition` (_ContentDisposition_) * `entity` (_object_) * `headers` (_object_) * `empty` (_boolean_) Additional properties: `array of string`. * `mediaType` (_MediaType_) * `messageBodyWorkers` (_MessageBodyWorkers_) * `parent` (_MultiPart_) * `providers` (_Providers_) * `parameterizedHeaders` (_object_) * `empty` (_boolean_) Additional properties: `array of ParameterizedHeader`.