openapi: 3.2.0 info: version: admin-v1 title: Admin API V1 Promotion Results API servers: - url: https://dogfood.commerce.insitesandbox.com security: [] tags: - name: Promotion Results paths: /api/v1/admin/PromotionResults: get: tags: - Promotion Results summary: Returns the EntitySet PromotionResults operationId: PromotionResults_Get parameters: - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $filter in: query description: Filters the results, based on a Boolean condition. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string - name: $apply in: query description: Aggregates the results according to one or more transformations. required: false schema: type: string - name: $orderby in: query description: Sorts the results. required: false schema: type: string - name: $top in: query description: Returns only the first n results. required: false schema: type: integer format: int32 - name: $skip in: query description: Skips the first n results. required: false schema: type: integer format: int32 - name: $count in: query description: Includes a count of the matching results in the response. required: false schema: type: boolean responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] post: tags: - Promotion Results summary: Post a new entity to EntitySet PromotionResults operationId: PromotionResults_Post requestBody: content: application/json: schema: $ref: '#/components/schemas/Insite.Data.Entities.PromotionResult' description: The entity to post required: true responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/PromotionResults({id}): get: tags: - Promotion Results summary: Returns the entity with the key from PromotionResults operationId: PromotionResults_GetById parameters: - name: id in: path description: 'key: id' required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] put: tags: - Promotion Results summary: Replace entity in EntitySet PromotionResults operationId: PromotionResults_PutById parameters: - name: id in: path description: 'key: id' required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/Insite.Data.Entities.PromotionResult' description: The entity to put required: true responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] delete: tags: - Promotion Results summary: Delete entity in EntitySet PromotionResults operationId: PromotionResults_DeleteById parameters: - name: id in: path description: 'key: id' required: true schema: type: string format: uuid - name: If-Match in: header description: If-Match header required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] patch: tags: - Promotion Results summary: Update entity in EntitySet PromotionResults operationId: PromotionResults_PatchById parameters: - name: id in: path description: 'key: id' required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: '#/components/schemas/Insite.Data.Entities.PromotionResult' description: The entity to patch required: true responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/PromotionResults/Default.Default(): get: tags: - Promotion Results summary: Call operation Default operationId: PromotionResults_Default responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/PromotionResults({id})/Default.import: post: tags: - Promotion Results summary: Call operation import operationId: PromotionResults_ImportProductsAsyncById parameters: - name: id in: path description: 'key: id' required: true schema: type: string format: uuid requestBody: $ref: '#/components/requestBodies/System.Threading.CancellationToken' responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/PromotionResults/Default.createtemporary: post: tags: - Promotion Results summary: Call operation createtemporary operationId: PromotionResults_CreateTemporaryAsync_1 requestBody: content: application/json: schema: type: object properties: existingPromotionResultId: format: guid type: string description: createtemporary action parameters responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/PromotionResults/Default.copyfromtemporary: post: tags: - Promotion Results summary: Call operation copyfromtemporary operationId: PromotionResults_CopyFromTemporary_1 requestBody: content: application/json: schema: required: - targetPromotionResultId - tempPromotionResultId type: object properties: targetPromotionResultId: format: guid type: string tempPromotionResultId: format: guid type: string description: copyfromtemporary action parameters required: true responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/promotionresults/createtemporary: post: tags: - Promotion Results operationId: PromotionResults_CreateTemporaryAsync_2 responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/promotionresults/copyfromtemporary: post: tags: - Promotion Results operationId: PromotionResults_CopyFromTemporary_2 responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/promotionresults({key})/import: post: tags: - Promotion Results operationId: PromotionResults_ImportProductsAsyncByKey parameters: - name: key in: path required: true schema: type: string format: uuid responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/promotionresults/delete: delete: tags: - Promotion Results operationId: PromotionResults_DeleteRoute parameters: - name: ids in: query required: true explode: true schema: type: array items: type: string format: uuid responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/promotionresults({key})/customproperties({custompropertyKey}): get: tags: - Promotion Results operationId: PromotionResults_GetCustomPropertyByKeyAndCustompropertykey parameters: - name: key in: path required: true schema: type: string format: uuid - name: custompropertyKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] /api/v1/admin/promotionresults({key})/products({productKey}): get: tags: - Promotion Results operationId: PromotionResults_GetProductByKeyAndProductkey parameters: - name: key in: path required: true schema: type: string format: uuid - name: productKey in: path required: true schema: type: string format: uuid - name: $expand in: query description: Expands related entities inline. required: false schema: type: string - name: $select in: query description: Selects which properties to include in the response. required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: object deprecated: false security: - access_token: [] components: schemas: System.Threading.CancellationToken: type: object properties: isCancellationRequested: type: boolean readOnly: true canBeCanceled: type: boolean readOnly: true waitHandle: $ref: '#/components/schemas/System.Threading.WaitHandle' Microsoft.Win32.SafeHandles.SafeWaitHandle: type: object properties: isInvalid: type: boolean readOnly: true isClosed: type: boolean readOnly: true System.Threading.WaitHandle: type: object properties: handle: type: object safeWaitHandle: $ref: '#/components/schemas/Microsoft.Win32.SafeHandles.SafeWaitHandle' Insite.Data.Entities.PromotionResult: required: - promotionResultType type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 promotionId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 productId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 amount: format: double type: number promotionResultType: maxLength: 100 minLength: 0 type: string visible: type: boolean shipViaId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 categoryId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 maxValue: format: double type: number qtyRequired: format: double type: number maxFree: format: double type: number isPercent: type: boolean vendorId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 brandId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 productLineId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 qualifyingProductId: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 customResultName: maxLength: 255 minLength: 0 type: string code: maxLength: 255 minLength: 0 type: string createdOn: format: date-time type: string createdBy: type: string modifiedOn: format: date-time type: string modifiedBy: type: string requestBodies: System.Threading.CancellationToken: content: application/json: schema: $ref: '#/components/schemas/System.Threading.CancellationToken' description: import action parameters required: true securitySchemes: access_token: type: apiKey description: Token used to access storefront API. name: access_token in: query