PriceZag API — Connect pricing data to your systems

curl -vX POST 'https://pricezag.com/api/v3/MYAPIKEY' -d '{"actions":[{"a":"productCreate","code":"000-SOME-TEST-PRODUCT","name":"Some Test Product created via PriceZag API","price":12.34,"currency":"USD"}]}'

curl -X POST 'https://pricezag.com/api/v3/MYAPIKEY' -d '{"actions":[{"a":"productGet","code":"000-SOME-TEST-PRODUCT"}]}' | python -mjson.tool

{
	"stopOnFailure"	: 1,  // (optional) By default our back-end normally continues to the next action upon failure. Setting this to 1 prevents it from continuing.

	// Array of all actions :
	"actions" : [
		// Action 1 :
		{
			"a"	: "someActionName",  // The action name is always the "a" variable of each action object
			"xx"	: "some parameter this action needs"	// everything besides "a" is whatever the action needs
		},
		// Action 2 :
		{
			"a"	: "anotherActionName",
			"abc"	: "some parameter this action needs",
			"xyz"	: {"x":"some object this action needs", "y":5, "z":6}
		},
		// Action 3 :
		{
			"a"	: "aThirdAction",
			"xyz"	: ["some array this action needs", "..."]
		}
	]
}

{
	"ok"		: 15,  // number of actions successfully performed (action ok>0)
	"errors"	: 0,  // number of actions that generated an error (action ok<0)
	"actionsCount"	: 20,  // total number of actions initially requested (the size of your actions array)
	// NOTE: we can conclude from this that 5 actions returned ok=0 (meaning that they didn't fail but they resulted in no change)
	
	// Array of all actions initially requested (same order) :
	"actions" : [
		...
		// Response object of each action:
		{
			"a"	: "someActionName",
			"ok"	: 4,		// Outcome. >0 = success, 0 = nothing changed, <0 = error
						// 0 can happen for example if you change the price of a product that is already at this price.
						// -1 would happen if that product doesn't exist.
						// >0 depends on the action. It is often the number of fields/things actually modified.
			"error"	: "...",  // Error message, if ok < 0
						// Our error strings are always very detailed. You should log them
						// because they will provide everything you need to understand what went wrong.
			...	// Whatever else the action returns that is specific to it
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"		: "productCreate",
		"code"		: "UNIQUE-REF-CODE",  // 1 to 80 max ([a-z\d][a-z\d_-]{0,78}[a-z\d]) Case-insensitive (converted to uppercase)
		"name"		: "The Product Name",  // 1 to 200 max
		"price"		: 1234.90,  // Watch out for commas and dots. No comma for thousands. Decimal point is a dot.
		"currency"	: "USD",
		"cost"		: 1234.90,  // (optional)
		"costCurrency"	: "USD",  // mandatory if cost
		"repricingRule"	: "The Rule Name",  // (optional) Repricing rule assigned (empty = disabled, non-existing = failure)
		"myWebsite"	: "https://...",  // (optional) URL or shopify:productId:variantId, or woocommerce:productId(:variationId)
		"competitors"	: ["https://...", "https://..."],  // (optional)
		"categories"	: ["The Category 1", "The Category 2"],  // (optional) categori(es) the product belongs to (non-existing = creates it)
		"comments"	: "Some comments\nAnd another line",  // (optional) 1000 UTF-8 characters max
		"custom_someFieldName1"	: "Value of custom field",		// (optional)
		"custom_someFieldName2"	: "Value of other\nCustom\tField",  // (optional)
		// Custom fields are for you to use internally for whatever purpose. They can be used in many places in your account, e.g. as columns when you export a spreadsheet.
		// You can have up to 20 custom fields per product. Their name is limited to 40 letters/numbers/underscore only (case-sensitive, not including the "custom_" prefix so 47 total).
		// Their value is limited to 500 bytes (characters typically, of any kind). You can set custom field values as a number (custom_varname:123)
		// but we will always return them as a string (custom_varname:"123") so remember to convert what you get from the API if necessary.
		// To delete a custom field simply set its value to "" and it will be removed entirely. Obviously this is not something that would happen in productCreate but in productEdit.
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"	: "productCreate",
			"ok"	: 1,
			"code"	: "REF-CODE",  // Final code in database (because we may convert your code if it contains special characters e.g.)
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"		: "productEdit",
		"code"		: "REF-CODE",
		...		// Takes the same parameters as productCreate, all of them optional.
		"newCode"	: "REF-CODE-RENAMED",  // (optional)
		"competitors"	: ["https://...", "https://..."],  // If present, OVERWRITES all existing competitor URLs.
		// If you only want to add or remove competitors to/from existing ones you need to use the productCompetitors action instead.
		"categories"	: ["The Category 1", "The Category 2"],  // if present, OVERWRITES current categories. Use productCategories or categoryEdit instead.
		"custom_someFieldName"	: "New value or empty to delete that custom field",
		// Keep in mind custom fields are limited to 20 per product, so if you want to add more you may need to first delete old ones by setting their value to "".
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"	: "productEdit",
			"ok"	: 3,  // Number of changes made (e.g. my price + 2 competitor URLs = 3)
			"code"	: "REF-CODE",  // Final (new) code in database (because we may convert your code if it contains special characters e.g.)
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"			: "productCompetitors",
		"code"			: "REF-CODE",
		"competitorsAdd"	: ["https://...", "https://..."],  // (optional) Add these competitor URLs to existing ones
		"competitorsRemove"	: ["https://...", "example.com/a0ff80...5f00", "example.net"],  // (optional) Remove these competitors. Each one can be:
		// > The URL (including any hashtag modifier you may have added). Labels are optional if you have any.
		// > The competitor "ref" (as returned by other actions, which is the root domain followed by an md5 of 32 characters)
		// > The root domain or full hostname, in which case all competitor URLs from this domain will be removed from the product.
		// NOTE: "competitorsAdd" and "competitorsRemove" can also be strings instead of arrays of a single element.
		// Remove is performed before Add so you can remove an entire domain and then add a URL from that domain.
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"			: "productCompetitors",
			"ok"			: 3,  // Number of competitor URLs modified
			"competitorsAdded"	: 2,  // Number of competitor URLs added to the product
			"competitorsRemoved"	: 1,  // Number of competitor URLs removed from the product
			// ERRORS:
			// > Adding a URL that is already present will NOT generate an error (ok = 0)
			// > Removing a full URL or URL "ref" that is NOT present will generate an error (ok = -1)
			// > Removing all URLs of a domain that is NOT present will NOT generate an error (ok = 0)
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"			: "productCategories",
		"code"			: "REF-CODE",  // case-insensitive (string), OR:
		"code"			: ["REF-CODE-1", "REF-CODE-2"],  // can also be an array with multiple products (100,000 limit)
		"categoriesRemove"	: ["The Category 1", "The Category 2"],  // (optional) First remove from these categories.
		"categoriesRemoveAll"	: 1,  // (optional) First remove from all categories (just like productEdit)
		"deleteEmptyCategories"	: 1,  // With this any category that becomes empty
		// as a result of having removed product(s) from it will be deleted.
		"categoriesAdd"		: ["The Category 1", "The Category 2"],  // (optional) Then add to these categories (non-existing = creates them)
		"categoriesAddClear"	: 1,  // (optional) First empty these categories we add the product(s) to
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"	: "productCategories",
			"ok"	: 3,  // Number of products modified
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"			: "productRepricing",
		"repricingRule"		: "The Rule Name",  // case-insensitive, "" (empty string but existing) means no rule (disable repricing)
		"products"		: ["REF-CODE-1", "REF-CODE-2"],  // case-insensitive (100,000 limit)
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"		: "productRepricing",
			"ok"		: 10,  // Number of products modified
			// So if all products were already assigned to that rule you will get ok=0.
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"	: "productDelete",
		"code"	: "REF-CODE",  // case-insensitive (string), OR:
		"code"	: ["REF-CODE-1", "REF-CODE-2"],  // can also be an array to delete multiple products (100,000 limit)
		"deleteEmptyCategories"	: 1,  // With this any category that becomes empty
		// as a result of having deleted this/these product(s) will be deleted as well.
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"	: "productDelete",
			"ok"	: 2,  // Number of products successfully deleted
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"			: "productGet",
		"code"			: "REF-CODE",  // case-insensitive
		"currency"		: "EUR",  // (optional) convert all amounts to this currency instead of the product price currency
		"withStats"		: 1,  // (optional) return the stats object
		"noCompetitors"		: 1,  // (optional) do not return the competitors array (to keep the data smaller)
		"noComments"		: 1,  // (optional) do not return the comments (...)
		"withScreenshots"	: 1,  // (optional) return the URL to latest screenshot image for each competitor
		"sickMax"		: 2,  // (optional, default 1) 0-3 return only competitor URLs with a sickness level up to N
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"			: "productGet",
			"ok"			: 1,
			"code"			: "REF-CODE",
			"name"			: "The Product Name",
			"price"			: 1234.90,  // Your own price, always in original currency
			"currency"		: "USD",  // Original currency of "price"
			"convCurrency"		: "EUR",  // Currency in which converted amounts are shown (either "currency" provided, or product price currency)
			"priceConv"		: 1234.90,  // Your own price converted using "convCurrency", or same as "price"
			"cost"			: 1234.90,
			"costCurrency"		: "USD",
			"costPriceConv"		: 1234.90,  // Your cost converted into price "currency"
			"costConv"		: 1234.90,  // Your cost converted into "convCurrency"
			"margin"		: 10.5,  // Percentage (can be negative)
			"repricingRule"		: "The Rule Name",  // These 3 repricing variables are ABSENT when there is no repricing
			"reprice"		: 1234.90,  // Current reprice amount calculated based on the repricingRule
			"repriceCurrency"	: "USD",  // Same as "convCurrency", just here for clarity
			"myWebsite"		: "https://...",
			"created"		: 1234567890,  // Epoch time at which the product was created
			"createdBy"		: "SOMEUSER",  // Username or "API"
			"edited"		: 1234567890,  // Epoch time of last edit (if ever)
			"editedBy"		: "SOMEUSER",  // Username or "API"
			"comments"		: "Some comments\nAnd another line",
			"commentsLast"		: 1234567890,  // Epoch time of last comments edited (if ever)
			"commentsLastBy"	: "SOMEUSER",  // Username or "API"
			"categories"		: ["The Category 1", "The Category 2"],
			"stats"		: {
				// Only competitor URLs of sickness level 0 and 1 count in the stats, regardless of your "sickMax".
				// All amounts are in "convCurrency", which means either the "currency" you provided or the product original "currency".
				// WARNING: when there is no amount (e.g. compIn* but no one is in stock) the value is 0.
				"rank"			: 1.23,  // Your rank in price (1 = no one is below you)
				"rankIn"		: 1.23,  // Your rank among in-stock competitors
				"compCount"		: 3,  // Nb of competitors having a valid price
				"compInCount"		: 3,  // Nb of in-stock competitors ...
				"compOutCount"		: 3,  // Nb of out-of-stock competitors ...
				"compAvg"		: 123.56,  // Average of all competitors
				"compAvgVsMe"		: 123.56,  // The gap (in convCurrency) between your price and competitors average (negative = you are lower)
				"compInAvg"		: 123.56,  // Average of in-stock competitors
				"compInAvgVsMe"		: 123.56,  // Same as "compAvgVsMe" but only in-stock competitors
				"compLowest"		: 123.56,  // Lowest competitor
				"compLowestVsMe"	: 123.56,  // Same as "compAvgVsMe" but for lowest instead of average
				"compInLowest"		: 123.56,  // Lowest competitor in-stock
				"compInLowestVsMe"	: 123.56,  // Same as "compInAvgVsMe" but ...
				"compHighest"		: 123.56,  // Highest competitor
				"compHighestVsMe"	: 123.56,  // Same as "compAvgVsMe" but ...
				"compInHighest"		: 123.56,  // Highest competitor in-stock
				"compInHighestVsMe"	: 123.56,  // Same as "compInAvgVsMe" but ...
			},
			"competitors"	: [
				// Array of competitors (cheapest first) where each competitor is an object :
				...
				{
					"url"		: "https://...",  // includes any hashtag modifier you may have put
					"ref"		: "example.com/123abc...def",
					// URL reference (which is the root domain followed by an md5 of 32 characters). This is how we identify URLs internally in our system.
					"domain"	: "example.com",  // root domain of this competitor
					"price"		: 1234.90,  // last amount found on the website (after any math based on your settings)
					"currency"	: "USD",  // currency found on the website
					"priceConv"	: 1234.90,  // price converted to "convCurrency"
					"stock"		: "5",  // inventory (string). "A" = available, "2" = 2 in stock, "0" = out of stock, "" = we don't know.
					"salesWk"	: 123,  // estimated sales/week (if we have - see question-mark in product page for explanation)
					"screenshotURL"	: "https://pricezag.com/.../screenshot.png",
					// if "withScreenshots", URL to the latest screenshot we have (no need to login, access is public with this long URL)
					"confidence"	: 98,
					// Percentage of confidence that we picked the right price (see explanation by clicking (?) in a product page)
					// Below 70% (configurable) is what we call "unreliable" in our platform by displaying a question mark next to the price.
					// This is independent from sickness. A URL can be sick but we know we picked the right price at the time,
					// or it can be healthy (we could visit) but we're not sure we picked the correct price in the page.
					"sick"		: 0,  // URL sickness level from 0 to 3
					// 0 : Our latest crawling worked (meaning we could visit and found a price in the page)
					// 1 : Our latest crawling failed but we succeeded recently (nothing to worry about, it happens all the time)
					// 2 : We could not get a valid price for many days
					// 3 : We could not get a valid price for many weeks
					// NOTE: the "price" and "priceConv" fields are only present for URLs of sickness level up to 1. Sickness 2 and 3 will have no price.
				},
				...
			],
			"custom"	: {
				// These are your custom fields. If you don't know how they work please open
				// a product page in the UI and click the (?) icon next to the CUSTOM FIELDS box.
				// When there is none, this entire "custom" object is absent.
				"variable_1"	: "value 1",  // Values are always strings, even when they are in fact numbers
				"variable_2"	: "value 2",  // and there is no such thing as an empty value, this would have deleted the variable.
				...
			}
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"			: "productGetAll",
		"currency"		: "EUR",  // (optional) convert all amounts to this currency instead of each product price currency
		"withStats"		: 1,  // (optional) return the stats object
		"noCompetitors"		: 1,  // (optional) do not return the competitors array (to keep the data smaller)
		"noComments"		: 1,  // (optional) do not return the comments (...)
		"withScreenshots"	: 1,  // (optional) return the URL to latest screenshot image for each competitor
		"sickMax"		: 2,  // (optional, default 1) 0-3 return only competitor URLs with a sickness level up to N
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"		: "productGetAll",
			"ok"		: 10,  // Total number of products
			"products"	: [ // array of products (alpha order of ref-code) where each product is an object :
				...
				{ ... },  // Product object just like the response of the productGet action (just above)
				...
			],
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"		: "categoryCreate",
		"name"		: "The New Category Name",
		"name"		: ["New Category 1", "New Category 2"],  // can also be an array
		"products"	: ["REF-CODE-1", "REF-CODE-2"],  // (optional) Put these products in this/these categori(es) as we create it/them
		"comments"	: "Some comments\nAnd another line",  // (optional) 1000 UTF-8 characters max
	},
	...
] }

{ "actions" : [
	...
	{
		"a"			: "categoryEdit",
		"name"			: "The Category Name",		// case-insensitive
		"newName"		: "The Category Renamed",  // (optional)
		"products"		: ["REF-CODE-1", "REF-CODE-2"],  // (optional) Overwrite list of products
		"productsAdd"		: ["REF-CODE-1", "REF-CODE-2"],  // (optional) Add these products to the category
		"productsRemove"	: ["REF-CODE-3", "REF-CODE-4"],  // (optional) Remove these products from the category (does NOT delete them)
		"comments"		: "To overwrite the comments.",  // (optional) 1000 UTF-8 characters max
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"			: "categoryEdit",
			"ok"			: 5,  // Number of modifications made
			// (renaming and editing comments each count as one, and so does each product added/removed)
			"name"			: "The Category Name",  // new name if renamed, or same old name
			"productsCount"		: 30,  // New number of products in this category (whether changed or not)
			"productsAdded"		: 2,  // Number of products added to the category
			"productsRemoved"	: 2,  // Number of products removed from the category
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"			: "categoryDelete",
		"name"			: "The Category Name",  // case-insensitive (string), OR:
		"name"			: ["Category 1", "Category 2"],  // can also be an array to delete multiple categories (1000 max)
		"deleteProducts"	: 1,
		// By default the category is deleted while its products drop out of it,
		// but with deleteProducts all products in the category are deleted without confirmation,
		// and the competitor URLs are deleted along with them without any way of restoring them!
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"			: "categoryDelete",
			"ok"			: 2,  // Number of categories deleted
			"productsCount"		: 123,  // Number of products concerned by this/these categori(es)
			"productsDeleted"	: 123,  // Number of products deleted as a result of the "deleteProducts" option
			// NOTE: a product that is in many of the categories provided will only count once
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"			: "categoryCopy",
		"categoriesFrom"	: ["Category 1", "Category 2"],  // Match the products from these categori(es) (the source)
		"removeMode"		: "cat",  // (optional) Remove corresponding products from the "categoriesFrom" provided
		"removeMode"		: "all",  // (optional) Remove corresponding products from all categories they are in
		// So if removeMode is omitted the products remain in "categoriesFrom" as they are also added to "categoriesTo" (copy instead of move)
		"deleteMode"		: "cat",  // (optional) Delete the "categoriesFrom" provided after copying products
		"deleteMode"		: "all",  // (optional) Delete all categories these products are in
		// So if deleteMode is omitted the "categoriesFrom" will still exist even after the products were removed from them with "removeMode".
		"categoriesTo"		: ["Another Category 1", "Another Category 2"],
		// Put all matching products into this/these destination categori(es) (non-existing = creates them)
		"categoriesToClear"	: 1,  // (optional) First empty these categories we add the product(s) to
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"			: "categoryCopy",
			"ok"			: 3,  // Number of categories altered (both source and destination)
			// "ok" is the sum of categoriesModified + categoriesCreated + categoriesDeleted
			"categoriesModified"	: 2,  // Number of existing categories modified (both source and destination)
			"categoriesCreated"	: 1,  // Number of new categories created
			"categoriesDeleted"	: 0,  // Number of categories deleted as a result of "deleteMode"
			"productsCount"		: 123,  // Number of products matching the "categoriesFrom" provided
			// NOTE: a product that is in many of the "categoriesFrom" provided will only count once
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"		: "categoryGet",
		"name"		: "The Category Name",  // case-insensitive
		"currency"	: "EUR",  // (MANDATORY if withStats or withProducts) currency to use for stats
		"withStats"	: 1,  // also return the statistics (slower)
		"withProducts"	: 1,  // also return the products of this category (can result in large data)
		"noCompetitors"	: 1,  // if withProducts, do not return the competitors array (to keep the data smaller)
		"noComments"	: 1,  // if withProducts, do not return the comments of products (still return category comments)
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"			: "categoryGet",
			"ok"			: 1,
			"name"			: "The Category Name",
			"created"		: 1234567890,  // Epoch time
			"createdBy"		: "SOMEUSER",  // Username or "API"
			"comments"		: "Comments of this category",
			"commentsLast"		: 1234567890,  // Epoch time of last comments edited (if ever)
			"commentsLastBy"	: "SOMEUSER",  // Username or "API"
			"productsCount"		: 10,  // Number of products in this category
			"stats"		: {
				// These stats are the ones shown in the UI in a category page and as columns in the list of categories.
				// For more details about each of them select them there as a column in the list and click (?).
				// All amounts are in the "currency" you provided in the request.
				// WARNING: when there is no amount (e.g. compIn* but no one is in stock) the value is 0.
				"priceAvg"		: 123.45,  // Your own average price
				"costAvg"		: 123.45,  // Only products that have a cost count in this average
				"marginAvg"		: 10.5,  // Percentage (can be negative, only products with a cost count)
				"rankAvg"		: 1.23,  // Your average rank in price (1 = no one is below you)
				"rankInAvg"		: 1.23,  // Your average rank among in-stock competitors
				"productsCountComp"	: 9,  // Number of products having competitor(s)
				"productsCountCompIn"	: 7,  // Number of products having in-stock competitor(s)
				"compAvg"		: 123.56,  // Average of all competitors averages
				"compAvgVsMe"		: 123.56,  // The average gap (in currency) between your price and competitors (negative = you are lower)
				"compInAvg"		: 123.56,  // Same as "compAvg" but only in-stock competitors
				"compInAvgVsMe"		: 123.56,  // Same as "compAvgVsMe" but only in-stock competitors
				"compLowest"		: 123.56,  // Same as "compAvg" but average of lowest competitor in each product
				"compLowestVsMe"	: 123.56,  // Same as "compAvgVsMe" but ...
				"compInLowest"		: 123.56,  // Same as "compInAvg" but ...
				"compInLowestVsMe"	: 123.56,  // Same as "compInAvgVsMe" but ...
				"compHighest"		: 123.56,  // Same as "compAvg" but average of highest competitor in each product
				"compHighestVsMe"	: 123.56,  // Same as "compAvgVsMe" but ...
				"compInHighest"		: 123.56,  // Same as "compInAvg" but ...
				"compInHighestVsMe"	: 123.56,  // Same as "compInAvgVsMe" but ...
			},
			"products"	: [ // array of products (alpha order of ref-code) where each product is an object :
				...
				{ ... },  // Product object just like the response of the productGet action
				...
			],
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"		: "categoryGetAll",
		"withStats"	: 1,  // also return the statistics (slower)
		"noComments"	: 1,  // do not return the comments (to keep the data smaller)
		"noProducts"	: 1,  // do not return the array of products (...)
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"		: "categoryGetAll",
			"ok"		: 10,  // Total number of categories (length of the "categories" array)
			"categories"	: [ // array of categories (alpha order) where each category is an object :
				...
				{
					"name"			: "The Category Name",
					"created"		: 1234567890,  // Epoch time
					"createdBy"		: "SOMEUSER",  // Username or "API"
					"comments"		: "Comments of this category",
					"commentsLast"		: 1234567890,  // Epoch time of last comments edited (if ever)
					"commentsLastBy"	: "SOMEUSER",  // Username or "API"
					"productsCount"		: 2,  // Number of products in this category
					"products"	: ["REF-CODE-1", "REF-CODE-2"],  // ref-codes of its products (alpha order) unless noProducts=1
					"stats"		: {
						// If "withStats", same stats object as the categoryGet action (just above)
						...
					},
				}
				...
			],
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"		: "alertRecipientCreate",
		"email"		: "john@example.net",  // can also be a phone number for SMS alerts - see help in the UI
		"name"		: "john",  // A simple display name (typically their first name, case-insensitive)
		"maxFrequency"	: 1800,  // (optional, default 7200) see help in the UI
		"simplify"	: 0,  // (optional, defaults to 1) Enable simplification (see help in the UI)
		"sleepEnabled"	: 1,  // (optional) Enable sleep time period
		"sleepFrom"	: "18:30",  // (only if sleepEnabled) 24-hour format
		"sleepTo"	: "07:00",  // (only if sleepEnabled) 24-hour format
		"timezone"	: "America/Los_Angeles",  // (only if sleepEnabled) Format is file path of Linux folders /usr/share/zoneinfo
				// Spaces will be converted to underscores.
				// Please go find your timezone in our [New Recipient] form in the UI to make sure you get it exactly right.
		"status"	: "hold",  // (optional) set "hold" or "disable" mode. Any other value (like "") is active.
		"rules"		: [...],  // (optional) Initial alert rules (array of rule objects) just like "rulesAdd" in alertRecipientEdit below
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"	: "alertRecipientCreate",
			"ok"	: 1,
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"		: "alertRecipientEdit",
		"email"		: "john@example.net",  // current email or phone number (exact same format as returned by the alertGetAll action)
		"newEmail"	: "john2@example.net",  // (optional) new email or phone number - see help in the UI
		"name"		: "john2",  // (optional) new name
		"maxFrequency"	: 1800,  // (optional) see help in the UI
		"simplify"	: 1,  // (optional) Enable simplification (see help in the UI)
		"sleepEnabled"	: 1,  // (optional) Enable sleep time period
		"sleepFrom"	: "18:30",  // (only if sleepEnabled) 24-hour format
		"sleepTo"	: "07:00",  // (only if sleepEnabled) 24-hour format
		"timezone"	: "America/Los_Angeles",  // (only if sleepEnabled) see alertRecipientCreate action above
		"status"	: "hold",  // (optional) set "hold" or "disable" mode. Any other value (like "") turns into "active".
		"rules"		: [{ruleObject}, {ruleObject}],  // (optional) Overwrite all existing rules (empty array to remove all)
				  // Do not provide any "rules" array if you want to keep existing rules
		"rulesAdd"	: [ // (optional) Will add these rules to existing ones
			...
			{  // THIS IS A RULE OBJECT FORMAT :
				"name"		: "me_cross_avg",  // see Alerts page > [Rules] > [+ New Rule] then select a rule to show its API name
				"disabled"	: 1,  // (optional) It would be silly to create a disabled rule, but the alertRuleEdit action below may use it
				"var_n"		: 123.00,  // An "X" variable becomes "var_x",
				"var_c"		: "USD",  // ... so these should be whatever the rule needs,
				"var_h"		: 24,  // ... (some of them don't have any variable).
				"direction"	: "both",  // Or "drop" or "rise", if the rule has a direction
				"categories"	: ["The Category 1", "The Category 2"],  // (optional) Empty or omitted means ALL PRODUCTS
				"ignoreOos"	: 1,  // (optional) Ignore out-of-stock competitors (see UI)
				"urlInclude"	: "",  // (optional, case-insensitive)
				"urlExclude"	: "amazon",  // (optional, case-insensitive)
				// "ruleNumber" is what identifies each rule (e.g. to edit/delete them later).
				// You will see it in the rule objects when you read them but you cannot set this.
			}
			...
		],
		"rulesRemove"	: [1,4,7],  // (optional) the "ruleNumber" of the rules to remove
					// You will get this "ruleNumber" from the alertGetAll action below.
					// NOTE: to remove all rules simply use "rules" = [] instead.
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"	: "alertRecipientEdit",
			"ok"	: 3,  // number of changes made (variables + number of rules added/deleted)
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"		: "alertRecipientDelete",
		"email"		: "john@example.net",  // current email or phone number (exact same format as returned by the alertGetAll action)
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"	: "alertRecipientDelete",
			"ok"	: 1,
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"		: "alertRuleEdit",
		"email"		: "john@example.net",  // email or phone number of the recipient (exact same format as returned by the alertGetAll action)
		"ruleNumber"	: 1,  // Ref number of the rule to edit, as returned by the alertGetAll action below.
		"rule"		: {
			// Variable(s) of the rule to overwrite - See "rulesAdd" in alertRecipientEdit above for RULE OBJECT FORMAT.
			"disabled"	: 1,  // for example, to enable/disable a rule
			"var_n"		: 5,  // or any other variable, like N for example, depending on the kind of rule
			...
		},
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"	: "alertRuleEdit",
			"ok"	: 1,  // number of variables modified
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"	: "alertGetAll",
		// This action does not take any parameters
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"		: "alertGetAll",
			"ok"		: 3,  // number of recipients (which is really just the size of the "recipients" array)
			"recipients"	: [ // array of all recipients, each being an object just like in the alertRecipientCreate action above
				...
				{
					"email"		: "john@example.net",
					"name"		: "john",
					"maxFrequency"	: 1800,
					"simplify"	: 0,
					"sleepEnabled"	: 1,
					"sleepFrom"	: "18:30",
					"sleepTo"	: "07:00",
					"timezone"	: "America/Los_Angeles",
					"status"	: "active",
					"rules"		: [ // array of rules, each being an object as described in the alertRecipientEdit action above
						...
						{
							"ruleNumber"	: 4,  // Reference number to use if you need to edit this rule using the alertRuleEdit action above
							"name"		: "me_cross_avg",
							"disabled"	: 0,
							"var_n"		: "123.00",  // NOTE: we return all vars as strings even when they are numbers
							"var_c"		: "USD",
							"var_h"		: "24",
							"direction"	: "both",
							"categories"	: [],  // empty means all products
							"ignoreOos"	: 0,
							"urlInclude"	: "",
							"urlExclude"	: "amazon",
						}
						...
					],
				}
				...
			],
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"	: "repricingCreate",
		"name"	: "The Rule Name",  // 50 characters maximum
		"init"	: { // object of initializer fallback (the first row called "Set my price to")
			"target"	: "cheapest_n",  // (see list below)
			"var_n"		: 3,  // only if the target requires an N variable
			"plusAmount"	: -2,  // positive for above, negative for below
			"plusCurrency"	: "%",  // currency (e.g. "USD") or "%"
			// So this corresponds to "Set my price 2% below average of 3 cheapest competitors"
			// WARNING: unlike the "never" objects below there is no "direction" for the initializer. It's the sign of "plusAmount" that determines below/above.
		},
		"never"	: [ // (optional) "but never" objects, executed in order (0 to 10 of them maximum)
			{
				"target"	: "cheapest_n_in",  // (see list below)
				"var_n"		: 1,  // only if the target requires an N variable
				"direction"	: "below",  // or "above"
				"plusAmount"	: -10,  // positive for plus, negative for minus (mandatory even if 0)
				"plusCurrency"	: "USD",  // currency or "%" (mandatory even if plusAmount=0)
				// So this corresponds to "But never below the cheapest competitor in-stock minus 10.00 USD"
			},
			{
				"target"	: "cost",
				"direction"	: "below",
				"plusAmount"	: 5,
				"plusCurrency"	: "%",
				// So this corresponds to "But never below my cost plus 5%"
			}
		],
		"ignoreDomains"	: "amazon ebay.com MyLabel1",  // (optional) domains and/or labels to ignore from competitors (case-insensitive, see UI)
		"charm"		: "none|zeros|charm",  // (optional, defauts to "none") charm pricing ("", "none" or omitted all result in the same thing)
		"confidence"	: 82,  // (optional, defauts to 70) minimum confidence percentage 0-99 (see UI)
		"disabled"	: 1,  // (optional)
	},
	...
] }
// ========== All "target" strings available : ==========
// "average"			: Average of all competitors
// "average_in"			: Average of all competitors in-stock
// "cheapest_n"			: Average of N cheapest competitors (or "The cheapest" if N=1)
// "cheapest_n_in"		: Average of N cheapest competitors in-stock (or ...)
// "highest_n"			: Average of N highest competitors (or ...)
// "highest_n_in"		: Average of N highest competitors in-stock (or ...)
// "cost"			: My cost
// "me_avg_n"			: My average price in last N hours (used to limit the speed at which your price changes)
// "domain:example.com"		: price of example.com (lowest if many from the same domain)
// "domainIn:example.com"	: price of example.com only if in-stock (...)

{
	...
	"actions" : [
		...
		{
			"a"	: "repricingCreate",
			"ok"	: 3,  // number of objects successfully parsed and saved (e.g. init + never[0] + never[1] = 3)
			"name"	: "The Rule Name",  // Final name in database (because we may convert your name if it contains special characters e.g.)
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"		: "repricingEdit",
		"name"		: "The Rule Name",  // case-insensitive
		"newName"	: "The Rule Renamed",  // (optional) 50 characters maximum
		"init"		: { // (optional) if present, overwrite any variable(s) of initializer fallback (see repricingCreate)
			"plusAmount"	: 1,  // for example, you could overwrite only "plusAmount" while the other variables remain the same
			// WARNING: don't forget that if the new "target" needs an N variable you must provide "var_n"
		},
		"never"		: [...], // (optional) You could overwrite the entire "never" array, but you probably want to use never_* instead.
		// This means that "never":[] erases all existing conditions. Omitting that variable is the way to keep them.
		"never_0"	: { // (optional) overwrite the first "but never" object (array index 0)
			"var_n"		: 2,  // for example, you could overwrite only "var_n" while the other variables remain the same
		},
		"never_2"	: {
			"target"	: "",  // this will disable the third "but never" condition (array index 2)
			// You don't have to worry about other variables of the object if "target" is set to "".
			// "never_2":{} does the same thing
		},
		"never_6"	: {...}, // This could be a new "but never" you add, in which case it requires all variables just like repricingCreate
		// "never_9" would be the maximum since the "never" array can take up to 10 elements
		"ignoreDomains"	: "",  // (optional) same as repricingCreate
		"charm"		: "zeros",  // (optional) ...
		"confidence"	: 82,  // (optional) ...
		"disabled"	: 1,  // (optional) 0 to enable a currently disabled rule
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"	: "repricingEdit",
			"ok"	: 3,  // number of changes made (e.g. one var from one never_N object + another from "init" object + "charm")
			"name"	: "The Rule Name",  // Final (new) name in database (because we may convert your name if it contains special characters e.g.)
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"		: "repricingDelete",
		"name"		: "The Rule Name",  // case-insensitive
		"onlyIfUnused"	: 1,  // (optional) For safety, you can use this to generate an error if the rule is used by some product(s)
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"		: "repricingDelete",
			"ok"		: 1,
			"productsCount"	: 10,  // Number of products that were using this rule (and now have none)
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"	: "repricingGetAll",
		// This action takes no other parameter
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"	: "repricingGetAll",
			"ok"	: 10,  // Total number of rules (length of the "rules" array)
			"rules"	: [ // array of repricing rules (alpha order) where each rule is an object :
				...
				{
					"name"		: "Some Repricing Rule",
					"created"	: 1234567890,  // Epoch time when rule was first created
					"createdBy"	: "SOMEUSER",  // Username or "API"
					"edited"	: 1234567890,  // Time last edited (if ever, otherwise variable is absent)
					"editedBy"	: "SOMEUSER",  // Username or "API" (or absent)
					"disabled"	: 1234567890,  // If the rule is currently disabled, epoch time at which it was last disabled. Otherwise absent.
					"disabledBy"	: "SOMEUSER",  // Username or "API" (or absent)
					"productsCount"	: 10,  // Number of products currently using this rule
					"ignoreDomains"	: "amazon ebay.com MyLabel1",  // domains and/or labels that are ignored from competitors (see UI)
					"charm"		: "charm",  // charm pricing mode (none|zeros|charm)
					"confidence"	: 82,  // minimum confidence percentage 0-99 (see UI)
					"init"	: { // object of initializer fallback (the first row called "Set my price to")
						"target"	: "cheapest_n",  // (see list in repricingCreate)
						"var_n"		: 3,  // if the target requires an N variable, otherwise absent
						"plusAmount"	: -2,  // positive for above, negative for below
						"plusCurrency"	: "%",  // currency (e.g. "USD") or "%"
						// So this corresponds to "Set my price 2% below average of 3 cheapest competitors"
						// WARNING: unlike the "never" objects below there is no "direction" for the initializer. It's the sign of "plusAmount" that determines below/above.
					},
					"never"	: [ // "but never" objects, executed in order
						{
							"target"	: "cheapest_n_in",
							"var_n"		: 1,
							"direction"	: "below",  // or "above"
							"plusAmount"	: -10,  // positive for plus, negative for minus
							"plusCurrency"	: "USD",  // currency or "%"
							// So this corresponds to "But never below the cheapest competitor in-stock minus 10.00 USD"
						},
						{},  // This means you left this second row of "But never" conditions empty
						{
							"target"	: "cost",
							"direction"	: "below",
							"plusAmount"	: 5,
							"plusCurrency"	: "%",
							// So this corresponds to "But never below my cost plus 5%"
						}
					],
				}
				...
			],
		},
		...
	]
}

{ "actions" : [
	{
		"a"		: "spreadsheetDownload",
		"preset"	: "Some Preset Name",  // (optional) Instead of providing everything below you can use one of your/our presets
			// For your own presets this should be the full name without any username before nor currency after.
			// For our default presets you can find their corresponding name by clicking the DIRECT DOWNLOAD drop-down in the export page and placing our mouse over them.
			// For example, "pricezag_backup" is our special backup preset (see "Special BACKUP format to re-import" in DIRECT DOWNLOAD drop-down)
			// You can also provide other variables below that will overwrite what your preset normally has (e.g. same preset in different currency, format, or categories).
		"savePreset"	: "My New Preset Name",  // (optional) To save everything you provide below as a new preset (which you can then use in both UI and API)
			// EXCEPTION of EXCEPTION: if you use savePreset no spreadsheet is downloaded and the response will instead be a JSON object as usual.
		"savePresetOverwrite"	: 1,  // (optional) To overwrite the existing preset provided as "savePreset" (will return an error otherwise)
			// WARNING: overwrite means nothing will remain from the previous preset, so do not attempt to only change one field.
			// To rename or delete a preset use the spreadsheetPresetEdit action below.
		"downloadURL"	: 1,  // (optional) EXCEPTION of EXCEPTION: Instead of returning the spreadsheet file it will return the usual JSON response with "fileURL" in the object,
			// which is a public URL to that file (no authentication nor API key required). The file will be available for 15 minutes for anyone to download from anywhere.
			// The "ok" value will be the number of rows and you will also see "fileSize" in bytes.
		"format"	: "xlsx|xls|csv|csv-tab",  // (defaults to csv for API)
		"currency"	: "USD",  // (MANDATORY unless preset) currency in which ALL amounts will be
		"categories"	: ["Category 1", "Category 2"],  // Only list products from these categori(es) (all products otherwise)
		"historyPeriod"	: "prev_6mo",  // (optional, defaults to "now")
			// FIRST, please click the question-marks (?) in our Export page about history periods as they explain everything about it.
			// "historyPeriod" determines how far in the past we read the amounts, before outputing this data as multiple rows per product according to "historyRow".
			// "now" : No history, only use current data (which implies no "historyRow")
			// "all" : Read the entire time period we have since you signed up (or at least for the products concerned). CAN BE SLOW.
			// "1234500000-1237800000" : read a custom time period ("from-to" epoch times)
			// "123h" : Last 123 hours. Does not snap to anything, so end will be right now and beginning can be in the middle of a clock hour.
			// "cur_123(d|wk|mo|yr)" : The last 123 day/week/month/year(s) including the current incomplete one. So "cur_2mo" downloaded on the 10th means 40 days.
			// "prev_123(d|wk|mo|yr)" : The previous finished 123 day/week/month/year(s). So "prev_2mo" downloaded on Feb 10th means the 62 days of December+January.
			// The starting time of cur_* and prev_* (and ending time of prev_*) always snap to the previous midnight time, while the end of cur_* is right now,
			// so "cur_2d" downloaded at noon covers the last 36 hours, while "prev_2d" will cover 48 hours ending 12 hours ago.
		"historyRow"	: "2w",  // (required, but only if "historyPeriod" is not "now")
			// "historyRow" determines how much time each row represents (avg of that period), therefore resulting in multiple rows per product (unless "all").
			// You can see "historyRow" as the SLICING of "historyPeriod" into individual spreadsheet rows for each product.
			// "all" : to average the entire historyPeriod as a single row per product.
			// "123(d|wk|mo|qt|yr)" : to snap at midnight to an interval of 123 calendar day/week/month/quarter/year(s). 123 can be omitted if 1 (so "wk" is fine instead of "1wk")
			// So if you download on Saturday using historyRow:"7d" each row will be the average amounts of all Saturday 00:00 to Friday 23:59 periods.
			// But if you use historyRow:"1wk" then each row will average each Monday 00:00 to Sunday 23:59 periods, and the most recent row will be the current incomplete week Mon-Sat.
			// ▶ 500,000 ROWS LIMIT: both our UI and API will refuse a history parameter that results in over 500K rows,
			// This could easily happen with historyRow:"day" if historyPeriod covers a lot of days, e.g. 365 days x 1400 products
			// If you really want this you need to download a spreadsheet per category of a couple hundred products each.
		"timezone"	: "America/Los_Angeles",  // (optional, defaults to "UTC") Format is file path of Linux folders /usr/share/zoneinfo
			// Spaces will be converted to underscores.
			// A time-zone is only useful if your history* options require some calendar-based periods (to determine when is midnight).
			// Our UI sets this to the time-zone of the current user based on their settings, but obviously the API has no such setting so it needs to be provided in the request.
		// ========== COLUMNS : ==========
		// With the column* variables you determine which columns the spreadsheet will have (see UI form in Export page for help about each of them)
		// All of them default to 0 (column won't be there) except Code.
		"columnCode"		: 1,  // (you cannot remove this one, there will always be a column with each product REF-CODE)
		"columnName"		: 1,  // Product name
		"columnCategories"	: 1,  // Categories the product is currently in ("Category 1; Category 2" in one cell)
		"columnComments"	: 1,  // Product comments
		"columnCreated"		: 1,  // Product creation date YYYY/MM/DD (in our system)
		"columnCustom"		: 1,  // The custom fields of your products (one column per unique variable among all products)
		"columnPrice"		: 1,  // Product price in the currency you requested (NOT in the product currency)
		"columnCost"		: 1,  // Product cost (in ...)
		"columnMargin"		: 1,  // Product margin percentage based on price and cost
		"columnRank"		: 1,  // My Rank
		"columnInRank"		: 1,  // My in-stock Rank
		"columnMyWebsite"	: 1,  // My Website URL
		"columnReprice"		: 1,  // Repricing Amount (in ...)
		"columnRepricingRule"	: 1,  // Repricing Rule name
		"columnRecommended"	: 1,  // Recommended price (see help in Export page)
		"columnCompUrls"	: 1,  // Competitors URLs (one per column)
		"columnCompUrlsJoin"	: 1,  // Competitors URLs (space-separated in a single cell)
		"columnCompMinMaxAvg"	: 1,  // Adds 3 columns: competitors Min/Max/Average
		"columnInCompMinMaxAvg"	: 1,  // Adds 3 columns: IN-STOCK competitors Min/Max/Average
		"columnCompPrice"	: 1,  // Adds 1 column per competitor with its price (in ...)
		"columnCompStock"	: 1,  // Adds 1 column per competitor with its stock (123|IN|OUT)
		"columnCompSales"	: 1,  // Adds 1 column per competitor with its sales/wk
		"columnCompRank"	: 1,  // Adds 1 column per competitor with its rank among all (you included)
		"columnCompInRank"	: 1,  // Adds 1 column per competitor with its rank among IN-STOCK comp. (you included)
		// ========== SECRET ADVANCED PARAMETERS : ==========
		// We also have a few unofficial options we don't really document, some of them used by our "pricezag_backup" preset for example.
		"originalCurrencies"	: 1,  // Instead of converting amounts to the currency your provide so that cells are numbers, cells will be text strings and include the original currency ("123.90 USD")
		"keepUrlLabels"		: 1,  // Normally we remove the labels of competitors URLs. This will keep them (useful for backups).
		"csvSeparator"		: ";",  // If you want the CSV format to use another separator character than comma or tab.
		"csvNoQuote"		: 1,  // Prevent CSV from ever using quotes ("). This could of course break the validity of the format.
	}
] }
// So a simple way to download a CSV spreadsheet backup would be :
// curl --connect-timeout 15 --max-time 600 --retry 2 -X POST 'https://pricezag.com/api/v3/MYAPIKEY' -d '{"actions":[{"a":"spreadsheetDownload","preset":"pricezag_backup"}]}' -o pricezag-backup-20241225.csv

{ "actions" : [
	{
		"a"		: "spreadsheetPresetEdit",
		"preset"	: "Some Preset Name",  // Current name of the preset
		"newName"	: "The Renamed Preset",  // To rename this preset
		"delete"	: 1,  // This will delete that "preset" from your account
		// NOTE: you cannot delete a preset that is used for auto-export (will return an error).
		// You need to first delete these scheduled auto-exports (see Export page).
	}
] }

{
	...
	"actions" : [
		...
		{
			"a"	: "spreadsheetPresetEdit",
			"ok"	: 1,
		},
		...
	]
}

{ "actions" : [
	{
		"a"			: "spreadsheetAutoCreate",
		"preset"		: "The Preset Name",
		"email"			: "john@example.net",
		"currency"		: "USD",  // (optional) Default is "preset" which makes us use the currency of that preset
		"attach"		: "link",  // (optional, defaults to "attach") "attach" for attached file, or "link" for hosted direct link
		"everyMonday"		: 1,  // Send the spreadsheet every Monday
		"everyTuesday"		: 1,  // ... (and so on for every day of the week until "everySunday")
		"everyMonthDay1"	: 15,  // Send every 15th of the month
		"everyMonthDay2"	: 21,  // ... and also every 21st
		"everyMonthDay3"	: "last",  // ... and also every last day of the month
			// everyMonthDay* can be from 0 to 9 for a maximum of 10 days ofo the month.
		"time"			: "3:59pm",  // "15.59" works too and would be converted to "3:59pm". "0:9", "0.09", "00:09", "0:09am" all work the same.
		"timezone"		: "America/Los_Angeles",  // (optional, defaults to "UTC") Format is file path of Linux folders /usr/share/zoneinfo
			// Spaces in city will be converted to underscores.
	}
] }

{
	...
	"actions" : [
		...
		{
			"a"	: "spreadsheetAutoCreate",
			"ok"	: 1,
			"id"	: "5gwi6fqa",  // The reference ID of this auto-export in case you need to modify it later (see action spreadsheetAutoEdit below)
		},
		...
	]
}

{ "actions" : [
	{
		"a"			: "spreadsheetAutoEdit",
		"id"			: "5gwi6fqa",  // The reference ID of the auto-export to edit.
			// You get this ID in the response of spreadsheetAutoCreate but you can also see it in the UI in the title of the pop-up that opens when you click the Edit button of an auto-export.
		"disabled"		: 1,  // (optional) 0 to enable a currently disabled auto-export
		"delete"		: 1,  // (optional) Delete this auto-export entirely
		// ===== The following (all optional) are then the same as in the spreadsheetAutoCreate action above =====
		"preset"		: "The Preset Name",
		"email"			: "john@example.net",
		"currency"		: "USD",
		"attach"		: "link",
		"everyMonday"		: 1,  // WARNING: whenever you provide at least one every* variable, all existing every* variables are erased,
		"everyMonthDay1"	: 15,  // so if you had "everyFriday"=1 before you edit, setting "everyMonthDay3" will remove that "everyFriday".
		// ... and so on (see spreadsheetAutoCreate for all every* variables)
		"time"			: "3:59pm",
		"timezone"		: "America/Los_Angeles",
	}
] }

{
	...
	"actions" : [
		...
		{
			"a"	: "spreadsheetAutoEdit",
			"ok"	: 3,  // number of changes made
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"		: "competitorDeleteAll",
		"domain"	: "competitordomain.com",
		"categories"	: ["The Category 1", "The Category 2"],  // (optional) if not provided you must use "allProducts" = 1
		"allProducts"	: 1,  // (optional) to delete from all products ("categories" must NOT be provided)
		// So it's either "categories" or "allProducts", not both, not none.
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"	: "competitorDeleteAll",
			"ok"	: 10,  // Number of URLs deleted
		},
		...
	]
}

{ "actions" : [
	...
	{
		"a"		: "mathEdit",
		"domain"	: "competitordomain.com",
		"clear"		: 1,  // (optional) To disable all math for that domain (will delete everything previously set)
		// If you set clear:1 you must not provide anything else below or it will generate an error.
		"math"	: [  // Array of math blocks to apply
			{  // This is a math block object, and all fields are optional.
				"categories"		: ["Category 1", "Category 2"],  // Only for products from these categories
				"theirPriceMin"		: 1234.90,  // Only when their price is greater or equal to N
				"theirPriceMinCurrency"	: "USD",  // Currency (can use "original" for same as website currency)
				"theirPriceMax"		: 1234.90,  // ... less or equal
				"theirPriceMaxCurrency"	: "USD",  // Currency (...)
				"themMeMin"		: -20.00,  // Only when [them-me] is greater or equal to N (see UI)
				"themMeMinCurrency"	: "USD",  // Currency or "%" of your own price (NOT "original" here)
				"themMeMax"		: -1.5,  // ... less or equal
				"themMeMaxCurrency"	: "%",  // Currency (...)
				"addPre"		: -10.00,  // Amount to add before multiplying (or remove if negative)
				"addPreCurrency"	: "USD",  // Currency (can use "original" for same as website currency)
				"multiply"		: 1.1,  // Multiply by this factor
				"divide"		: 1.1,  // OR divide (do not provide both)
				"addPost"		: 5.00,  // Amount to add after multiplying (or remove if negative)
				"addPostCurrency"	: "USD",  // Currency (...)
				// Seems overwhelming? Check out our simple example below the response.
			},
			... // Up to 10 blocks total (math will be applied in order)
		],
		// NOTE: We do not currently provide a way to only modify a single variable or math block. If you provide the math array it will replace everything that might be there.
		// NOTE: Any math block that neither multiplies nor divides (unset or 1) and doesn't have addPre!=0 or addPost!=0 will be ignored,
		// and if all of them	are ignored then it will have the same effect as deleting all math with clear:1
		// In other words your math have to actually do something to be saved.
		// TRICK: if you ever need to temporarily disable the math of a domain without deleting everything,
		// you can set categories : ["Some Empty Existing Category"]
	},
	...
] }

{
	...
	"actions" : [
		...
		{
			"a"	: "mathEdit",
			"ok"	: 3,  // number of math blocks changed (removing/clearing is a change)
		},
		...
	]
}

{ "actions" : [
	{
		"a"		: "mathEdit",
		"domain"	: "amazon.co.uk",
		"math"		: [
			{
				"divide"	: 1.1
			}
		]
	}
] }