action jumpseller_get_promotions_id_json { label: "Retrieve a single Promotion." provider: jumpseller method: GET path: "/promotions/{id}.json" encoding: json input: { type: "object" properties: { id: { type: "integer" format: "int32" } } required: ["id"] additionalProperties: false } output: { type: "object" properties: { promotion: { type: "object" properties: { begins_at: { type: "string" description: "Creation date of the promotion (requires 'lasts' param - 'date')" } categories: { type: "array" description: "Products Categories where the promotion will be applied (requires 'discount_target' param - 'categories')" items: { properties: { id: { type: "integer" format: "int32" } } } } code: { type: "string" description: "Code of the promotion" } condition_price: { type: "number" format: "float" description: "Minimum order amount to validate the promotion" } condition_qty: { type: "integer" format: "int32" description: "Minimum quantity of ordered itens to validate the promotion" } cumulative: { type: "boolean" description: "True if the promotion can be acumulated with others" } customer_categories: { type: "array" description: "Customer Categories to whom the promotion will be applied (requires 'customers' param - 'categories')" items: { type: "object" additionalProperties: true } } discount_amount_fix: { type: "number" format: "float" description: "Fixed discount amount of the promotion" } discount_amount_percent: { type: "number" format: "float" description: "Percentual discount amount of the promotion" } discount_target: { type: "string" description: "Where the promotion will be applied ('order', 'shipping', 'categories', 'buy_x_get_y)" } enabled: { type: "boolean" description: "If the promotion is currently enabled" } expires_at: { type: "string" description: "Expiration date of the promotion (requires 'lasts' param - 'date')" } id: { type: "integer" format: "int32" description: "Unique identifier of the product" } lasts: { type: "string" description: "Controls when the promotion will expire ('none', 'date', 'max_times_used')" } max_times_used: { type: "integer" format: "int32" description: "Maximum amount a promotion can be used (requires 'lasts' param - 'max_times_used')" } name: { type: "string" description: "Name of the product" } products: { type: "array" description: "Products where the promotion will be applied (requires 'discount_target' param - 'categories' or 'buy_x_get_y')" items: { type: "object" additionalProperties: true } } products_x: { type: "array" description: "Products required to apply the promotion (requires 'discount_target' param - 'buy_x_get_y')" items: { type: "object" additionalProperties: true } } quantity_x: { type: "integer" format: "int32" description: "Number of sets of products_x needed to be able to apply the promotion (requires 'discount_target' param - 'buy_x_get_y')" } status: { type: "string" description: "Status of the promotion ('active', 'expired')" } times_used: { type: "integer" format: "int32" description: "Amount of times the promotion was used" } } } } } }