{ "uuid": "91088411-a248-466c-9f58-20c9747e29b1", "lastMigration": 29, "name": "Marketing API", "endpointPrefix": "sell/marketing/v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "0991180d-ca26-4a6d-8151-6bdc66ca30db", "documentation": "This method retrieves the details for all the campaigns of a seller, including the campaign's the selection rules. Note that this method does not return the listing IDs or inventory reference IDs of the items included in the ad campaign. Call getAds to retrieve these IDs. You can filter the result set by a campaign name, end date range, start date range, or campaign status. You can also paginate the records returned from the result set using the limit query parameter, and control which records to return using the offset parameter.", "method": "get", "endpoint": "ad_campaign", "responses": [ { "uuid": "58254322-f0d7-40ae-992e-567c924321bf", "body": "{\n \"campaigns\": [\n {\n \"campaignCriterion\": {\n \"autoSelectFutureInventory\": {{faker 'datatype.boolean'}},\n \"criterionType\": \"\",\n \"selectionRules\": [\n {\n \"brands\": [\n \"\"\n ],\n \"categoryIds\": [\n \"\"\n ],\n \"categoryScope\": \"\",\n \"listingConditionIds\": [\n \"\"\n ],\n \"maxPrice\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"minPrice\": {\n \"currency\": \"\",\n \"value\": \"\"\n }\n }\n ]\n },\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"campaignStatus\": \"\",\n \"endDate\": \"\",\n \"fundingStrategy\": {\n \"bidPercentage\": \"\",\n \"fundingModel\": \"\"\n },\n \"marketplaceId\": \"\",\n \"startDate\": \"\"\n }\n ],\n \"href\": \"\",\n \"limit\": {{faker 'number.int' max=99999}},\n \"next\": \"\",\n \"offset\": {{faker 'number.int' max=99999}},\n \"prev\": \"\",\n \"total\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6bf41b07-9209-4550-9cc4-171cb9321b86", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9da9d070-b7a1-4281-97a6-c1525f46b13b", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a7d2ff36-99c6-4db5-b763-edcf123bd99b", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "cb3f4acf-0799-4c07-8378-f38232590e86", "documentation": "This method creates a Promoted Listings ad campaign. A Promoted Listings campaign is the structure into which you place the ads for the listings you want to promote. Identify the items you want to place into a campaign either by "key" or by "rule" as follows: Rules-based campaigns – A rules-based campaign adds items to the campaign according to the criteria you specify in your call to createCampaign. Key-based campaigns – Add items to an existing campaign using either listing ID values or Inventory Reference values: Add listingId values to an existing campaign by calling either createAdByListingID or bulkCreateAdsByListingId. Add inventoryReference values to an existing campaign by calling either createAdByInventoryReference or bulkCreateAdsByInventoryReference. Note: No matter how you add items to a Promoted Listings campaign, each campaign can contain ads for a maximum of 50,000 items. If a rules-based campaign identifies more than 50,000 items, ads are created for only the first 50,000 items identified by the specified criteria, and ads are not created for the remaining items. Creating a campaign To create a basic campaign, supply: The user-defined campaign name The start date (and optionally the end date) of the campaign The eBay marketplace on which the campaign is hosted Details on the campaign funding model The campaign funding model specifies how the Promoted Listings fee is calculated. Currently, the only supported funding model is COST_PER_SALE. For complete information on how the fee is calculated and when it applies, see Promoted Listings fees. If you populate the campaignCriterion object in your createCampaign request, campaign "ads" are created by "rule" for the listings that meet the criteria you specify, and these ads are associated with the newly created campaign. For details on creating Promoted Listings campaigns and how to select the items to be included in your campaigns, see Creating a Promoted Listings campaign. For recommendations on which listings are prime for a Promoted Listings ad campaign and to get guidance on how to set the bidPercentage field, see Using the Recommendation API to help configure campaigns. Tip: See Promoted Listings requirements and restrictions for the details on the marketplaces that support Promoted Listings via the API.", "method": "post", "endpoint": "ad_campaign", "responses": [ { "uuid": "19f3ce03-8c6d-4f4a-b27a-e4219db646cc", "body": "{}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bc13e591-ce28-40ef-b803-b5c891983f8d", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2f8b6229-a7a0-402c-93ac-9b9fc0c9c982", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0a21b5a7-12a3-4b3f-a6d7-3fb3d2158c5f", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "de9d18f8-e238-4786-ae53-2428ef345774", "documentation": "This method retrieves the campaigns containing the listing that is specified using either a listing ID, or an inventory reference ID and inventory reference type pair. eBay listing IDs are generated by either the Trading API or the Inventory API when you create a listing. An inventory reference ID can be either a seller-defined SKU or inventoryItemGroupKey, as specified in the Inventory API. Note: This request accepts either a listing_id, or an inventory_reference_id and inventory_reference_type pair, as used in the Inventory API.", "method": "get", "endpoint": "ad_campaign/find_campaign_by_ad_reference", "responses": [ { "uuid": "c0b37832-1a82-4edb-890f-a8cc0c2ea427", "body": "{\n \"campaigns\": [\n {\n \"campaignCriterion\": {\n \"autoSelectFutureInventory\": {{faker 'datatype.boolean'}},\n \"criterionType\": \"\",\n \"selectionRules\": [\n {\n \"brands\": [\n \"\"\n ],\n \"categoryIds\": [\n \"\"\n ],\n \"categoryScope\": \"\",\n \"listingConditionIds\": [\n \"\"\n ],\n \"maxPrice\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"minPrice\": {\n \"currency\": \"\",\n \"value\": \"\"\n }\n }\n ]\n },\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"campaignStatus\": \"\",\n \"endDate\": \"\",\n \"fundingStrategy\": {\n \"bidPercentage\": \"\",\n \"fundingModel\": \"\"\n },\n \"marketplaceId\": \"\",\n \"startDate\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f644b548-7c08-4a0f-b9a8-9b05da1b8699", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5e7b410d-090b-4d06-9437-f7ef677e14a2", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b8c3de09-f2ed-4cb5-94f0-c82f8465a7c9", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bb8defed-462f-4d48-a137-370db04ad9c6", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "63792bf4-134e-48f2-b367-73c6ba48945c", "documentation": "This method retrieves the details of a single campaign, as specified with the campaign_name query parameter. Note that the campaign name you specify must be an exact, case-sensitive match of the name of the campaign you want to retrieve. This method returns all the details of a campaign (including the campaign's the selection rules), except the for the listing IDs or inventory reference IDs included in the campaign. These IDs are returned by getAds. Call getCampaigns to retrieve a list of the seller's campaign names.", "method": "get", "endpoint": "ad_campaign/get_campaign_by_name", "responses": [ { "uuid": "e01a0e9c-494d-4fa2-b837-9c6a42da25ca", "body": "{\n \"campaignCriterion\": {\n \"autoSelectFutureInventory\": {{faker 'datatype.boolean'}},\n \"criterionType\": \"\",\n \"selectionRules\": [\n {\n \"brands\": [\n \"\"\n ],\n \"categoryIds\": [\n \"\"\n ],\n \"categoryScope\": \"\",\n \"listingConditionIds\": [\n \"\"\n ],\n \"maxPrice\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"minPrice\": {\n \"currency\": \"\",\n \"value\": \"\"\n }\n }\n ]\n },\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"campaignStatus\": \"\",\n \"endDate\": \"\",\n \"fundingStrategy\": {\n \"bidPercentage\": \"\",\n \"fundingModel\": \"\"\n },\n \"marketplaceId\": \"\",\n \"startDate\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ec93b870-2d19-40eb-b12d-f1ba40ab98d8", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6ce2a24f-7e85-4dbe-88b2-873744ee2582", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f08fe160-dcfe-4791-8047-d8c17b3e40e8", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "652a9101-8988-4ce2-9d19-f6ce9898be26", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "94dacf29-63fd-4d3f-a473-d19dc64966b5", "documentation": "This method deletes the campaign specified by the campaign_id query parameter. Note: You can delete only campaigns that have ended. Call getCampaigns to retrieve the campaign_id and the campaign status (RUNNING, PAUSED, ENDED, and so on) for all the seller's campaigns.", "method": "delete", "endpoint": "ad_campaign/:campaign_id", "responses": [ { "uuid": "06ed6636-54e5-41b6-9628-2640771d3c25", "body": "", "latency": 0, "statusCode": 204, "label": "No Content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "75bf96ae-a110-430c-bbd3-afd4869d18fb", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "86112b1d-7fd0-440a-acb9-1c69cc0cfa84", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1b771bf2-5589-41f4-8bb1-4ad37ac7a633", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "24ec6262-83e0-40ae-8041-5a524beb4c35", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "44d8fab9-1a35-4a3e-be6c-49a5898c81dd", "documentation": "This method retrieves the details of a single campaign, as specified with the campaign_id query parameter. This method returns all the details of a campaign (including the campaign's the selection rules), except the for the listing IDs or inventory reference IDs included in the campaign. These IDs are returned by getAds. Call getCampaigns to retrieve a list of the seller's campaign IDs.", "method": "get", "endpoint": "ad_campaign/:campaign_id", "responses": [ { "uuid": "d91b4793-3cc0-4e59-90a5-b325eadf62b0", "body": "{\n \"campaignCriterion\": {\n \"autoSelectFutureInventory\": {{faker 'datatype.boolean'}},\n \"criterionType\": \"\",\n \"selectionRules\": [\n {\n \"brands\": [\n \"\"\n ],\n \"categoryIds\": [\n \"\"\n ],\n \"categoryScope\": \"\",\n \"listingConditionIds\": [\n \"\"\n ],\n \"maxPrice\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"minPrice\": {\n \"currency\": \"\",\n \"value\": \"\"\n }\n }\n ]\n },\n \"campaignId\": \"\",\n \"campaignName\": \"\",\n \"campaignStatus\": \"\",\n \"endDate\": \"\",\n \"fundingStrategy\": {\n \"bidPercentage\": \"\",\n \"fundingModel\": \"\"\n },\n \"marketplaceId\": \"\",\n \"startDate\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "8fc11252-133f-4c90-86cb-2afbc7282b9e", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "813889d9-0e20-4c89-bd31-a37b17292db0", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f9372189-4eff-4d90-b332-cd92d83eac5d", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "53648946-11e0-4f26-801e-420dbdbb8a16", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5250c7b9-deed-4892-8095-58ef2b7cfb1c", "documentation": "This method retrieves Promoted Listings ads that are associated with listings created with either the Trading API or the Inventory API. The method retrieves ads related to the specified campaign. Specify the Promoted Listings campaign to target with the campaign_id path parameter. Because of the large number of possible results, you can use query parameters to paginate the result set by specifying a limit, which dictates how many ads to return on each page of the response. You can also specify how many ads to skip in the result set before returning the first result using the offset path parameter. Call getCampaigns to retrieve the current campaign IDs for the seller.", "method": "get", "endpoint": "ad_campaign/:campaign_id/ad", "responses": [ { "uuid": "6cb18b06-b27c-4238-a837-4cfc68264703", "body": "{\n \"ads\": [\n {\n \"adId\": \"\",\n \"bidPercentage\": \"\",\n \"inventoryReferenceId\": \"\",\n \"inventoryReferenceType\": \"\",\n \"listingId\": \"\"\n }\n ],\n \"href\": \"\",\n \"limit\": {{faker 'number.int' max=99999}},\n \"next\": \"\",\n \"offset\": {{faker 'number.int' max=99999}},\n \"prev\": \"\",\n \"total\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "386fe2eb-c91d-4212-be88-39cefdcde3b3", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "153802aa-9f7b-4d6c-9a31-83b70a859133", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "44784ec9-6e02-4ad3-b205-1e8f8ed443ad", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0d468ef8-fba9-4c63-8f85-aee378c27787", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "ab564f8f-9d95-43bb-8bae-ded9e8925701", "documentation": "This method works with listings created with either the Trading API or the Inventory API. The method: Creates an ad for the specified listing ID. Sets the bid percentage (also known as the "ad rate") for the ad. Associates the ad with the specified campaign. To create an ad for a listing, specify its listingId, plus the bidPercentage for the ad in the payload of the request. Specify the campaign to associate the ad with using the campaign_id path parameter. Listing IDs are generated by eBay when a seller creates listings with the Trading API or Inventory API. Each campaign can have ads for a maximum of 50,000 items, and each item in a multiple-variation listing is considered as an single item. Use createCampaign to create a new campaign and use getCampaigns to get a list of existing campaigns.", "method": "post", "endpoint": "ad_campaign/:campaign_id/ad", "responses": [ { "uuid": "80b49502-2bbd-4115-bcdb-62887be2f21f", "body": "{}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "35a2ef42-d6d7-46d0-bb9d-b865c0306305", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9dafccca-e921-4793-96b3-17123da07f2b", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0fe629e0-615e-4fdc-9597-38a465933615", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6d8b1263-f6c1-4d75-bf54-c6853bcbb396", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "07213196-d7ee-4c78-bac5-6a988f070499", "documentation": "This method removes the specified ad from the specified campaign. Pass the ID of the ad to delete with the ID of the campaign associated with the ad as path parameters to the call. Call getCampaigns to get the current list of the seller's campaign IDs.", "method": "delete", "endpoint": "ad_campaign/:campaign_id/ad/:ad_id", "responses": [ { "uuid": "6770bde2-02fc-43f7-85d8-430c2cfd8a3f", "body": "", "latency": 0, "statusCode": 204, "label": "No Content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "45fc5fa9-f89a-4320-9bcf-fbff23b5ecd0", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0e76ced0-a553-4bf2-8938-37049e166843", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "14fc6ba4-ed18-438c-8ff4-2098f6170699", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9447a71b-1726-4f0f-bb53-254403ee5cbb", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9b4a9d6b-869c-4525-a978-2460f9e3856d", "documentation": "This method retrieves the specified ad from the specified campaign. In the request, supply the campaign_id and ad_id as path parameters. Call getCampaigns to retrieve a list of the seller's current campaign IDs and call getAds to retrieve their current ad IDs.", "method": "get", "endpoint": "ad_campaign/:campaign_id/ad/:ad_id", "responses": [ { "uuid": "75adff9f-03ae-4af5-b0e0-3c79d0f94a5b", "body": "{\n \"adId\": \"\",\n \"bidPercentage\": \"\",\n \"inventoryReferenceId\": \"\",\n \"inventoryReferenceType\": \"\",\n \"listingId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2ceeff5f-d1e3-4efa-8255-6a3e95722eaf", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "22ee2117-848f-4c4c-94d9-111bef32e761", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "29f448a2-1f17-40a5-b689-b83af17ab432", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "83dcac95-6e10-4572-a2d3-62aec46e9799", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "82f530ee-5cdf-447d-8501-77fdbf46f120", "documentation": "This method updates the bid percentage (also known as the "ad rate") for the specified ad in the specified campaign. In the request, supply the campaign_id and ad_id as path parameters, and supply the new bidPercentage value in the payload of the call. Call getCampaigns to retrieve a seller's current campaign IDs and call getAds to get their ad IDs.", "method": "post", "endpoint": "ad_campaign/:campaign_id/ad/:ad_id/update_bid", "responses": [ { "uuid": "107ac035-4f9b-4be8-918b-5b315cea8ef0", "body": "", "latency": 0, "statusCode": 204, "label": "No content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "30a7fdee-83f4-4c0f-9d13-84288bc6402c", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "bb77b3d9-63c8-4b1c-b744-f804a80d12d9", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f7ddcaee-7f86-41d1-8acc-0ece4512a5f0", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4f588c5e-2093-47b7-8409-908d88d30082", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5afb0e6e-e702-4225-b062-ca540d86fadc", "documentation": "This method adds multiple listings that are managed with the Inventory API to an existing Promoted Listings campaign. For each listing specified in the request, this method: Creates an ad for the listing. Sets the bid percentage (also known as the ad rate) for the ad. Associates the ad with the specified campaign. To create an ad for a listing, specify its inventoryReferenceId and inventoryReferenceType, plus the bidPercentage for the ad in the payload of the request. Specify the campaign to associate the ads to with using the campaign_id path parameter. In the Inventory API, an inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (a seller-defined ID for a multiple-variation listing). You can specify a maximum of 500 items per call and each campaign can have ads for a maximum of 50,000 items. Be aware when using this call that each variation in a multiple-variation listing creates an individual ad. Use createCampaign to create a new campaign and use getCampaigns to get a list of existing campaigns.", "method": "post", "endpoint": "ad_campaign/:campaign_id/bulk_create_ads_by_inventory_reference", "responses": [ { "uuid": "86a02d1a-f55e-4a27-81cc-21cdb07f7733", "body": "{\n \"responses\": [\n {\n \"ads\": [\n {\n \"adId\": \"\",\n \"href\": \"\"\n }\n ],\n \"errors\": [\n {\n \"category\": \"\",\n \"domain\": \"\",\n \"errorId\": {{faker 'number.int' max=99999}},\n \"inputRefIds\": [\n \"\"\n ],\n \"longMessage\": \"\",\n \"message\": \"\",\n \"outputRefIds\": [\n \"\"\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"subdomain\": \"\"\n }\n ],\n \"inventoryReferenceId\": \"\",\n \"inventoryReferenceType\": \"\",\n \"statusCode\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d24cc4af-4786-4b8a-88d2-8b0293f6f8ae", "body": "", "latency": 0, "statusCode": 207, "label": "Multi Status", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0c68e325-fb35-4a46-af83-16860998c662", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "290ca907-0668-415e-9439-ef285c726a63", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5ecb2a43-2f66-4cfa-9383-43c5377aefba", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a8fbad3a-047e-4739-8df1-70aa2c3fe4dc", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1a3831de-5419-4cc2-9120-fc6a78ae4e1a", "documentation": "This method adds multiple listings to an existing Promoted Listings campaign using listingId values generated by either the Trading API or Inventory API. For each listing ID specified in the request, this method: Creates an ad for the listing. Sets the bid percentage (also known as the ad rate) for the ad. Associates the ad with the specified campaign. To create an ad for a listing, specify its listingId, plus the bidPercentage for the ad in the payload of the request. Specify the campaign to associate the ads with using the campaign_id path parameter. Listing IDs are generated by eBay when a seller creates listings with the Trading API. You can specify a maximum of 500 listings per call and each campaign can have ads for a maximum of 50,000 items. Be aware when using this call that each variation in a multiple-variation listing creates an individual ad. Use createCampaign to create a new campaign and use getCampaigns to get a list of existing campaigns.", "method": "post", "endpoint": "ad_campaign/:campaign_id/bulk_create_ads_by_listing_id", "responses": [ { "uuid": "4394b0f9-d3a6-4131-9c9e-ee0cafd207ff", "body": "{\n \"responses\": [\n {\n \"adId\": \"\",\n \"errors\": [\n {\n \"category\": \"\",\n \"domain\": \"\",\n \"errorId\": {{faker 'number.int' max=99999}},\n \"inputRefIds\": [\n \"\"\n ],\n \"longMessage\": \"\",\n \"message\": \"\",\n \"outputRefIds\": [\n \"\"\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"subdomain\": \"\"\n }\n ],\n \"href\": \"\",\n \"listingId\": \"\",\n \"statusCode\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0418cb50-aecc-4467-b52a-4b18d8cd8b1e", "body": "", "latency": 0, "statusCode": 207, "label": "Multi Status", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2103a9e1-ede1-4588-9625-aaf88050407f", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "84dce81a-c354-444a-a58c-941ff559d4f8", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b1c9bce0-e2ac-4110-96a0-709e7f8fff89", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "09fa6485-6262-4d7b-88b0-b551211d6c4b", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1ced1fbd-06f6-4ffe-8bf8-770dc9eaf1f0", "documentation": "This method works with listings created with the Inventory API. The method deletes a set of ads, as specified by a list of inventory reference IDs, from the specified campaign. Inventory reference IDs are seller-defined IDs that are used with the Inventory API. Pass the campaign_id as a path parameter and populate the payload with a list of inventoryReferenceId and inventoryReferenceType pairs that you want to delete. Get the campaign IDs for a seller by calling getCampaigns and call getAds to get a list of the seller's inventory reference IDs.", "method": "post", "endpoint": "ad_campaign/:campaign_id/bulk_delete_ads_by_inventory_reference", "responses": [ { "uuid": "3303f1e9-6d01-4601-acb9-6d6f315f108d", "body": "{\n \"responses\": [\n {\n \"adIds\": [\n \"\"\n ],\n \"errors\": [\n {\n \"category\": \"\",\n \"domain\": \"\",\n \"errorId\": {{faker 'number.int' max=99999}},\n \"inputRefIds\": [\n \"\"\n ],\n \"longMessage\": \"\",\n \"message\": \"\",\n \"outputRefIds\": [\n \"\"\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"subdomain\": \"\"\n }\n ],\n \"inventoryReferenceId\": \"\",\n \"inventoryReferenceType\": \"\",\n \"statusCode\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "a9c1dda0-1323-423c-a062-8ff53f739dd8", "body": "", "latency": 0, "statusCode": 207, "label": "Multi Status", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4455a0a7-8e03-4749-836d-028aa9e9c19e", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "63b6bf75-cb7a-42dc-8c56-b42a134f7228", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0abb2f97-6457-47bb-bf20-34c8aff82f19", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "36cf61c6-8d86-483d-bb59-1b76fe3633b1", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6bbc248f-9e67-4726-9bdc-e2b6d7895e4a", "documentation": "This method works with listing IDs created with either the Trading API or the Inventory API. The method deletes a set of ads, as specified by a list of listingID values from a Promoted Listings campaign. A listing ID value is generated by eBay when a seller creates a listing with either the Trading API and Inventory API. Pass the campaign_id as a path parameter and populate the payload with the set of listing IDs that you want to delete. Get the campaign IDs for a seller by calling getCampaigns and call getAds to get a list of the seller's inventory reference IDs.", "method": "post", "endpoint": "ad_campaign/:campaign_id/bulk_delete_ads_by_listing_id", "responses": [ { "uuid": "d93b1886-776e-401a-a0ad-80494845ec6b", "body": "{\n \"responses\": [\n {\n \"adId\": \"\",\n \"errors\": [\n {\n \"category\": \"\",\n \"domain\": \"\",\n \"errorId\": {{faker 'number.int' max=99999}},\n \"inputRefIds\": [\n \"\"\n ],\n \"longMessage\": \"\",\n \"message\": \"\",\n \"outputRefIds\": [\n \"\"\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"subdomain\": \"\"\n }\n ],\n \"listingId\": \"\",\n \"statusCode\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d0968ea0-478d-4c02-ab66-b321295b9e47", "body": "", "latency": 0, "statusCode": 207, "label": "Multi Status", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "55bb983b-7c8c-4bc8-b8cd-6de51eca610d", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "679fb32e-9fe4-44e7-90f9-c059d4fe5d3b", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4b938f06-3caa-4deb-bece-7ff91c403318", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "716e5c54-0756-45dd-b305-8c7b2c6301eb", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "20bbcaed-aec1-4357-929f-5f3e89da0693", "documentation": "This method works with listings that are managed with the Inventory API. The method updates the bidPercentage values for a set of ads associated with the specified campaign. Specify the campaign_id as a path parameter and supply a list of inventoryReferenceId and inventoryReferenceType pairs with the updated bidPercentage values in the request body. In the Inventory API, an inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (a seller-defined ID for a multiple-variation listing). Get the campaign IDs for a seller by calling getCampaigns and call getAds to get a list of the seller's inventory reference IDs.", "method": "post", "endpoint": "ad_campaign/:campaign_id/bulk_update_ads_bid_by_inventory_reference", "responses": [ { "uuid": "06aa595d-58c0-4f5a-8157-1f352fb6be51", "body": "{\n \"responses\": [\n {\n \"ads\": [\n {\n \"adId\": \"\",\n \"href\": \"\"\n }\n ],\n \"errors\": [\n {\n \"category\": \"\",\n \"domain\": \"\",\n \"errorId\": {{faker 'number.int' max=99999}},\n \"inputRefIds\": [\n \"\"\n ],\n \"longMessage\": \"\",\n \"message\": \"\",\n \"outputRefIds\": [\n \"\"\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"subdomain\": \"\"\n }\n ],\n \"inventoryReferenceId\": \"\",\n \"inventoryReferenceType\": \"\",\n \"statusCode\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "d741fb07-f299-4a28-b172-46a6c14f36d6", "body": "", "latency": 0, "statusCode": 207, "label": "Multi Status", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0b40d784-b6f7-41c7-81e5-b2f9f0627890", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "617bb88e-6b48-4fef-8f32-f5a1df983c88", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "890e4e67-5f1d-4f1c-aa95-4155e90cf7d2", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "80799bea-93dd-4e2e-bd3a-67c29f2d73c2", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e1ee3c15-fa4d-41f5-a5be-ff39531c38ff", "documentation": "This method works with listings created with either the Trading API or the Inventory API. The method updates the bidPercentage values for a set of ads associated with the specified campaign. Specify the campaign_id as a path parameter and supply a set of listing IDs with their associated updated bidPercentage values in the request body. An eBay listing ID is generated when a listing is created with the Trading API. Get the campaign IDs for a seller by calling getCampaigns and call getAds to get a list of the seller's inventory reference IDs.", "method": "post", "endpoint": "ad_campaign/:campaign_id/bulk_update_ads_bid_by_listing_id", "responses": [ { "uuid": "532cfeed-8b3b-49b0-ac31-d3bccdf59c93", "body": "{\n \"responses\": [\n {\n \"adId\": \"\",\n \"errors\": [\n {\n \"category\": \"\",\n \"domain\": \"\",\n \"errorId\": {{faker 'number.int' max=99999}},\n \"inputRefIds\": [\n \"\"\n ],\n \"longMessage\": \"\",\n \"message\": \"\",\n \"outputRefIds\": [\n \"\"\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"subdomain\": \"\"\n }\n ],\n \"href\": \"\",\n \"listingId\": \"\",\n \"statusCode\": {{faker 'number.int' max=99999}}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "919e2412-c4ed-4f49-b672-c91370078535", "body": "", "latency": 0, "statusCode": 207, "label": "Multi Status", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9c763e1d-68f6-4b5e-9fd9-3d977562eaa7", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2de6c451-ccc8-4b6f-9ede-cfc12bbac45b", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8270b16e-c5e5-46ca-ad78-1167761f14e8", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f88db217-9d5b-4f6a-86bd-d34d28366f41", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1761ea69-c051-462f-88f2-998615ea7481", "documentation": "This method clones (makes a copy of) the specified campaign. To clone a campaign, supply the campaign_id as a path parameter in your call, there is no call payload. The ID of the newly-cloned campaign is returned in the Location response header. Call getCampaigns to retrieve a seller's current campaign IDs Requirement: In order to clone a campaign, the campaignStatus must be ENDED and the campaign must define a set of selection rules (it must be a rules-based campaign).", "method": "post", "endpoint": "ad_campaign/:campaign_id/clone", "responses": [ { "uuid": "f1f258c4-dd84-4b4f-a3c3-f8cbaeeae4b6", "body": "{}", "latency": 0, "statusCode": 201, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "f431c942-b1da-4302-b47d-6f38a7656c51", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e544fe0b-2daf-4283-aa0e-f92f4dae98a7", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5b475448-4d7a-409b-916f-1f806ec97dcb", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f5a4abeb-3ad8-4d79-be90-abfeda51b426", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1fd58071-f08f-435a-a27b-66824fd35c70", "documentation": "This method works with listings that are managed with the Inventory API. The method: Creates an ad for the specified listing. Sets the bid percentage (also known as the "ad rate") for the ad. Associates the ad with the specified campaign. To create an ad for a listing, specify its inventoryReferenceId and inventoryReferenceType, plus the bidPercentage for the ad in the payload of the request. Specify the campaign to associate the ad with using the campaign_id path parameter. In the Inventory API, an inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (a seller-defined ID for a multiple-variation listing). Each campaign can have ads for a maximum of 50,000 items, and each item in a multiple-variation listing is considered as an individual item. Use createCampaign to create a new campaign and use getCampaigns to get a list of existing campaigns.", "method": "post", "endpoint": "ad_campaign/:campaign_id/create_ads_by_inventory_reference", "responses": [ { "uuid": "ea8cd33a-c465-4703-bacf-509a0c02e3b4", "body": "{\n \"ads\": [\n {\n \"adId\": \"\",\n \"href\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b0252547-e46b-4e0c-a67a-ec3b8a56b396", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c2a543d2-c114-49ad-a37b-333c361248a9", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cd9b9d43-ac2d-4849-bdbc-ad6a7ce5d78b", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "95db167d-b6b7-4fce-97a1-d19bacadba78", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "abf66c13-1673-4bc6-a890-ec6319816505", "documentation": "This method works with listings that are managed with the Inventory API. The method deletes ads using a list of seller-defined inventory reference IDs, used with the Inventory API, that are associated with the specified campaign ID. Specify the campaign ID (as a path parameter) and a list of inventoryReferenceId and inventoryReferenceType pairs to be deleted. Call getCampaigns to get a list of the seller's current campaign IDs.", "method": "post", "endpoint": "ad_campaign/:campaign_id/delete_ads_by_inventory_reference", "responses": [ { "uuid": "e0cc88c0-1ba2-4f40-914c-c021af94599b", "body": "{\n \"adIds\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b0584310-374a-4a6a-b499-15aaac499c5f", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e9478791-866e-4ed3-a156-b10b4dfcf022", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6520db3e-52ac-4c49-8d9f-79f4ef85d6b8", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dc4c2bed-a8dc-4fad-907d-2e16fcd97ab6", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a24b5c1a-a211-429c-a8c0-872e3c570508", "documentation": "This method ends an active (RUNNINGM) or paused campaign. Specify the campaign you want to end by supplying its campaign ID in a query parameter. Call getCampaigns to retrieve the campaign_id and the campaign status (RUNNING, PAUSED, ENDED, and so on) for all the seller's campaigns.", "method": "post", "endpoint": "ad_campaign/:campaign_id/end", "responses": [ { "uuid": "6eac7916-d35f-4393-827c-51e4e501ef87", "body": "", "latency": 0, "statusCode": 204, "label": "No Content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "1c3d69aa-a1fd-4575-80e9-e04aa9334830", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0ac825bc-1a6e-4105-8988-5824f78c4844", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a23688fe-a0f3-4443-81ea-b9a2a92d4a0b", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a721f2ab-6fb7-4b1e-b350-a201c925bd40", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "33b80b9e-7e90-4100-af1e-741dfc1a922a", "documentation": "This method retrieves Promoted Listings ads associated with listings that are managed with the Inventory API from the specified campaign. Supply the campaign_id as a path parameter and use query parameters to specify the inventory_reference_id and inventory_reference_type pairs. In the Inventory API, an inventory reference ID is either a seller-defined SKU value or an inventoryItemGroupKey (a seller-defined ID for an inventory item group, which is an entity that's used in the Inventory API to create a multiple-variation listing). To indicate a listing managed by the Inventory API, you must always specify both an inventory_reference_id and the associated inventory_reference_type. Call getCampaigns to retrieve all of the seller's the current campaign IDs.", "method": "get", "endpoint": "ad_campaign/:campaign_id/get_ads_by_inventory_reference", "responses": [ { "uuid": "5d0b1df8-4139-4b71-8eaf-9dcfe626df98", "body": "{\n \"ads\": [\n {\n \"adId\": \"\",\n \"bidPercentage\": \"\",\n \"inventoryReferenceId\": \"\",\n \"inventoryReferenceType\": \"\",\n \"listingId\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "745e035a-f186-41be-a93a-c28cbc5022b2", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fd6fc620-810b-418b-a14a-8968199f77d1", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dcbfb382-7730-4138-be83-438f4cf29165", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "895acb8a-bd44-4438-ae77-8f7537646164", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e23550e8-4239-4ace-ba87-2296c935574a", "documentation": "This method pauses an active (RUNNING) campaign. You can restarted by calling resumeCampaign, as long as the campaign's end date is in the future. Note: The listings associated with a paused campaign cannot be added into another campaign. Call getCampaigns to retrieve the campaign_id and the campaign status (RUNNING, PAUSED, ENDED, and so on) for all the seller's campaigns.", "method": "post", "endpoint": "ad_campaign/:campaign_id/pause", "responses": [ { "uuid": "631e8272-dde7-4fc5-b3d6-4e2d8a14c7a4", "body": "", "latency": 0, "statusCode": 204, "label": "No Content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b4127687-c2c6-47eb-9296-fac272863424", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ecd6a425-7008-43b2-86b9-abae71356f3a", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7323a67a-bcc4-4549-8cc7-9dbb2b3629bd", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "df8eb469-4cfb-487f-ba8e-18ddf6ce622c", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "24b3cc11-4151-4961-b0b9-de4c9b920281", "documentation": "This method resumes a paused campaign, as long as it's end date is in the future. Supply the campaign_id for the campaign you want to restart as a query parameter in the request. Call getCampaigns to retrieve the campaign_id and the campaign status (RUNNING, PAUSED, ENDED, and so on) for all the seller's campaigns.", "method": "post", "endpoint": "ad_campaign/:campaign_id/resume", "responses": [ { "uuid": "9430ea00-85a0-4b11-8a31-9231998ff505", "body": "", "latency": 0, "statusCode": 204, "label": "No content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "fc661b85-4f85-4641-bea8-b9b2417ad3e2", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "53a0d95c-99b7-4e61-afc1-fb2c978b9015", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "611797d7-2d0d-418a-af6b-476cd71b5c6f", "body": "", "latency": 0, "statusCode": 409, "label": "Business error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "278c0e4b-4ced-46df-ac67-b296c07a3dd3", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "18b86596-1042-43d8-afef-9163ddd08109", "documentation": "This method replaces the name and the start and end dates of a campaign. Specify the campaign_id you want to update as a URI parameter, and configure the campaignName and startDate in the request payload. If you want to change only the end date of the campaign, specify the current campaign name and set startDate to the current date (you cannot use a start date that is in the past), and set the endDate as desired. Note that if you do not set a new end date in this call, any current endDate value will be set to null. To preserve the currently-set end date, you must specify the value again in your request. Call getCampaigns to retrieve a seller's campaign details, including the campaign ID, campaign name, and the start and end dates of the campaign.", "method": "post", "endpoint": "ad_campaign/:campaign_id/update_campaign_identification", "responses": [ { "uuid": "9a201d23-3012-4d5b-a900-989f6a2a685a", "body": "", "latency": 0, "statusCode": 204, "label": "No content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "361dfa6a-fe6e-41b5-a283-3cefaba6d93c", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a1bb8f83-6ffa-4de2-a140-085a28efa3d9", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "46809642-1ed8-42a9-aedd-2ae8d0ae56bd", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "94d69d46-39ae-4f8e-99f6-9c8b55c2b24a", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e8872618-4aaa-4f10-85dc-f7abd6b79c94", "documentation": "This call downloads the report as specified by the report_id path parameter. Call createReportTask to schedule and generate a Promoted Listings report. All date values are returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ).", "method": "get", "endpoint": "ad_report/:report_id", "responses": [ { "uuid": "2209b8d4-a5a8-4382-8e8f-d9a1617b5cc5", "body": "", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "text/tab-separated-values" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "30740bc9-ee54-419b-9d3f-de143e9fc77a", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2b3b6378-ea4b-4eb7-8633-ea5c7e19e511", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "f47464d4-f242-4d0a-beb5-ffb47a08ff94", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f6ef2ecd-fbed-492c-9a5f-2a433ebe7dcf", "documentation": "This call retrieves information that details the fields used in each of the Promoted Listings reports. Use the returned information to configure the different types of Promoted Listings reports. The request for this method does not use a payload or any URI parameters.", "method": "get", "endpoint": "ad_report_metadata", "responses": [ { "uuid": "35888228-e069-484c-9257-a6f6a28ac9cb", "body": "{\n \"reportMetadata\": [\n {\n \"dimensionMetadata\": [\n {\n \"dataType\": \"\",\n \"dimensionKey\": \"\",\n \"dimensionKeyAnnotations\": [\n {\n \"annotationKey\": \"\",\n \"dataType\": \"\"\n }\n ]\n }\n ],\n \"maxNumberOfDimensionsToRequest\": {{faker 'number.int' max=99999}},\n \"maxNumberOfMetricsToRequest\": {{faker 'number.int' max=99999}},\n \"metricMetadata\": [\n {\n \"dataType\": \"\",\n \"metricKey\": \"\"\n }\n ],\n \"reportType\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6d1ec49f-1e7b-49eb-a4c8-e480fe048edd", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1fda4f1b-ce5b-48bd-bc4e-9da78fdcc310", "documentation": "This call retrieves metadata that details the fields used by a specific Promoted Listings report type. Use the report_type path parameter to indicate metadata to retrieve. This method does not use a request payload.", "method": "get", "endpoint": "ad_report_metadata/:report_type", "responses": [ { "uuid": "41285476-22ae-4593-a370-cac978cc3628", "body": "{\n \"dimensionMetadata\": [\n {\n \"dataType\": \"\",\n \"dimensionKey\": \"\",\n \"dimensionKeyAnnotations\": [\n {\n \"annotationKey\": \"\",\n \"dataType\": \"\"\n }\n ]\n }\n ],\n \"maxNumberOfDimensionsToRequest\": {{faker 'number.int' max=99999}},\n \"maxNumberOfMetricsToRequest\": {{faker 'number.int' max=99999}},\n \"metricMetadata\": [\n {\n \"dataType\": \"\",\n \"metricKey\": \"\"\n }\n ],\n \"reportType\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bf425fd2-dcf8-4c50-8c72-38cdc9c2606a", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "755d2449-7dca-402a-b6a5-4c738f08cdd2", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9d37c193-a7b6-4e35-be4f-268c34d1d161", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c0e5f71f-7803-4a42-a836-c63bba2c2477", "documentation": "This method returns information on all the existing report tasks related to a seller. Use the report_task_statuses query parameter to control which reports to return. You can paginate the result set by specifying a limit, which dictates how many report tasks to return on each page of the response. Use the offset parameter to specify how many reports to skip in the result set before returning the first result.", "method": "get", "endpoint": "ad_report_task", "responses": [ { "uuid": "6c558a17-256b-4238-b7ef-3df517ae754f", "body": "{\n \"href\": \"\",\n \"limit\": {{faker 'number.int' max=99999}},\n \"next\": \"\",\n \"offset\": {{faker 'number.int' max=99999}},\n \"prev\": \"\",\n \"reportTasks\": [\n {\n \"campaignIds\": [\n \"\"\n ],\n \"dateFrom\": \"\",\n \"dateTo\": \"\",\n \"dimensions\": [\n {\n \"annotationKeys\": [\n \"\"\n ],\n \"dimensionKey\": \"\"\n }\n ],\n \"inventoryReferences\": [\n {\n \"inventoryReferenceId\": \"\",\n \"inventoryReferenceType\": \"\"\n }\n ],\n \"listingIds\": [\n \"\"\n ],\n \"marketplaceId\": \"\",\n \"metricKeys\": [\n \"\"\n ],\n \"reportExpirationDate\": \"\",\n \"reportFormat\": \"\",\n \"reportHref\": \"\",\n \"reportId\": \"\",\n \"reportName\": \"\",\n \"reportTaskCompletionDate\": \"\",\n \"reportTaskCreationDate\": \"\",\n \"reportTaskExpectedCompletionDate\": \"\",\n \"reportTaskId\": \"\",\n \"reportTaskStatus\": \"\",\n \"reportTaskStatusMessage\": \"\",\n \"reportType\": \"\"\n }\n ],\n \"total\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "edc04f15-708f-4e57-b76c-4bac9f67f462", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d1a9ae47-f778-40d2-90c2-ea46cc0bbdd4", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "6d01e75b-c5f5-4901-b550-ae63d70c4deb", "documentation": "This method creates a report task, which generates a Promoted Listings report based on the values specified in the call. The report is generated based on the criteria you specify, including the report type, the report's dimensions and metrics, the report's start and end dates, the listings to include in the report, and more. Metrics are the quantitative measurements in the report while dimensions specify the attributes of the data included in the reports. When creating a report task, you can specify the items you want included in the report. The items you specify, using either listingId or inventoryReference values, must be in a Promoted Listings campaign for them to be included in the report. For details on the required and optional fields for each report type, see Creating Promoted Listings reports. This call returns the URL to the report task in the Location response header, and the URL includes the report-task ID. Reports often take time to generate and it's common for this call to return an HTTP status of 202, which indicates the report is being generated. Call getReportTasks (or getReportTask with the report-task ID) to determine the status of a Promoted Listings report. When a report is complete, eBay sets its status to SUCCESS and you can download it using the URL returned in the reportHref field of the getReportTask call. Report files are tab-separated value gzip files with a file extension of .tsv.gz. Note: This call fails if you don't submit all the required fields for the specified report type. Fields not supported by the specified report type are ignored. Call getReportMetadata to retrieve a list of the fields you need to configure for each Promoted Listings report type.", "method": "post", "endpoint": "ad_report_task", "responses": [ { "uuid": "5c44cc69-7167-4e36-b283-35f65e5be6ea", "body": "", "latency": 0, "statusCode": 202, "label": "Accepted", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "22ed2acd-d23f-4359-9d02-c1d13b5fb17d", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7742b882-3648-4230-a44d-a6be8f251aae", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8d3c0f9b-30c2-4969-abba-d02ab8dfb381", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "283cd3a6-08c0-4b87-960f-8162605a284b", "documentation": "This call deletes the report task specified by the report_task_id path parameter. This method also deletes any reports generated by the report task. Report task IDs are generated by eBay when you call createReportTask. Get a complete list of a seller's report-task IDs by calling getReportTasks.", "method": "delete", "endpoint": "ad_report_task/:report_task_id", "responses": [ { "uuid": "a2072d12-bd06-4ca7-b781-6e91830935d8", "body": "", "latency": 0, "statusCode": 204, "label": "No Content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "2d929647-613d-4f45-8605-d66905f76145", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "13c0d916-af84-478d-bf95-9c311a34e46c", "body": "", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7d073325-b5b0-4aac-824e-1cc283cfdfa0", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "277f4555-43c0-4e4a-9b40-fedc5a1d1b10", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3fe7be85-dea9-4e7e-b81b-2e34e839e1b4", "documentation": "This call returns the details of a specific Promoted Listings report task, as specified by the report_task_id path parameter. The report task includes the report criteria (such as the report dimensions, metrics, and included listing) and the report-generation rules (such as starting and ending dates for the specified report task). Report-task IDs are generated by eBay when you call createReportTask. Get a complete list of a seller's report-task IDs by calling getReportTasks.", "method": "get", "endpoint": "ad_report_task/:report_task_id", "responses": [ { "uuid": "6dafb712-df4e-4eb7-a931-b01231091be5", "body": "{\n \"campaignIds\": [\n \"\"\n ],\n \"dateFrom\": \"\",\n \"dateTo\": \"\",\n \"dimensions\": [\n {\n \"annotationKeys\": [\n \"\"\n ],\n \"dimensionKey\": \"\"\n }\n ],\n \"inventoryReferences\": [\n {\n \"inventoryReferenceId\": \"\",\n \"inventoryReferenceType\": \"\"\n }\n ],\n \"listingIds\": [\n \"\"\n ],\n \"marketplaceId\": \"\",\n \"metricKeys\": [\n \"\"\n ],\n \"reportExpirationDate\": \"\",\n \"reportFormat\": \"\",\n \"reportHref\": \"\",\n \"reportId\": \"\",\n \"reportName\": \"\",\n \"reportTaskCompletionDate\": \"\",\n \"reportTaskCreationDate\": \"\",\n \"reportTaskExpectedCompletionDate\": \"\",\n \"reportTaskId\": \"\",\n \"reportTaskStatus\": \"\",\n \"reportTaskStatusMessage\": \"\",\n \"reportType\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6e36d473-863f-4a4a-9a58-b9f65e9f9207", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "66e701ed-2417-4db9-b706-20098f65826d", "body": "", "latency": 0, "statusCode": 404, "label": "Not found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a471e5e7-b0da-4881-aaef-15508125abec", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b791e1dd-cdbc-46f9-9958-65248c8801d4", "documentation": "This method creates an item price markdown promotion (know simply as a "markdown promotion") where a discount amount is applied directly to the items included the promotion. Discounts can be specified as either a monetary amount or a percentage off the standard sales price. eBay highlights promoted items by placing teasers for the items throughout the online sales flows. Unlike an item promotion, a markdown promotion does not require the buyer meet a "threshold" before the offer takes effect. With markdown promotions, all the buyer needs to do is purchase the item to receive the promotion benefit. Important: There are some restrictions for which listings are available for price markdown promotions. For details, see Promotions Manager requirements and restrictions. In addition, we recommend you list items at competitive prices before including them in your markdown promotions. For an extensive list of pricing recommendations, see the Growth tab in Seller Hub. There are two ways to add items to markdown promotions: Key-based promotions select items using either the listing IDs or inventory reference IDs of the items you want to promote. Note that if you use inventory reference IDs, you must specify both the inventoryReferenceId and the associated inventoryReferenceType of the item(s) you want to include the promotion. Rule-based promotions select items using a list of eBay category IDs or seller Store category IDs. Rules can further constrain items in a promotion by minimum and maximum prices, brands, and item conditions. New promotions must be created in either a DRAFT or a SCHEDULED state. Use the DRAFT state when you are initially creating a promotion and you want to be sure it's correctly configured before scheduling it to run. When you create a promotion, the promotion ID is returned in the Location response header. Use this ID to reference the promotion in subsequent requests (such as to schedule a promotion that's in a DRAFT state). Tip: Refer to Promotions Manager in the Selling Integration Guide for details and examples showing how to create and manage seller promotions. Markdown promotions are available on all eBay marketplaces. For more information, see Promotions Manager requirements and restrictions.", "method": "post", "endpoint": "item_price_markdown", "responses": [ { "uuid": "c935418b-3204-42eb-a142-9da0c3f81e00", "body": "{}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5802313c-25aa-4729-ac68-c56cbb7b5234", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2b4cf91b-da69-444a-9cc2-0c33831d049a", "body": "", "latency": 0, "statusCode": 409, "label": "Conflict", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "38a5690d-71e5-4042-819a-f693f05d0e31", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "77bbc833-f7a6-4c21-ae89-f297ab9576f4", "documentation": "This method deletes the item price markdown promotion specified by the promotion_id path parameter. Call getPromotions to retrieve the IDs of a seller's promotions. You can delete any promotion with the exception of those that are currently active (RUNNING). To end a running promotion, call updateItemPriceMarkdownPromotion and adjust the endDate field as appropriate.", "method": "delete", "endpoint": "item_price_markdown/:promotion_id", "responses": [ { "uuid": "f07f4338-a511-4fdf-98b9-15e418c89854", "body": "", "latency": 0, "statusCode": 204, "label": "No Content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "4abd87f2-6072-47c5-8a67-9a6f0f1f9325", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "697bcc1c-9642-483f-94cf-85ccc7d76cb4", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "73532823-d205-412a-9c5b-324f213a2f5c", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "0db86d28-0377-4797-9bd5-83959c46cb0e", "documentation": "This method returns the complete details of the item price markdown promotion that's indicated by the promotion_id path parameter. Call getPromotions to retrieve the IDs of a seller's promotions.", "method": "get", "endpoint": "item_price_markdown/:promotion_id", "responses": [ { "uuid": "74c30557-065d-45cd-b433-49264d7627d3", "body": "{\n \"applyFreeShipping\": {{faker 'datatype.boolean'}},\n \"autoSelectFutureInventory\": {{faker 'datatype.boolean'}},\n \"blockPriceIncreaseInItemRevision\": {{faker 'datatype.boolean'}},\n \"description\": \"\",\n \"endDate\": \"\",\n \"marketplaceId\": \"\",\n \"name\": \"\",\n \"priority\": \"\",\n \"promotionImageUrl\": \"\",\n \"promotionStatus\": \"\",\n \"selectedInventoryDiscounts\": [\n {\n \"discountBenefit\": {\n \"amountOffItem\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"amountOffOrder\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"percentageOffItem\": \"\",\n \"percentageOffOrder\": \"\"\n },\n \"discountId\": \"\",\n \"inventoryCriterion\": {\n \"inventoryCriterionType\": \"\",\n \"inventoryItems\": [\n {\n \"inventoryReferenceId\": \"\"\n }\n ],\n \"listingIds\": [\n \"\"\n ],\n \"ruleCriteria\": {\n \"excludeInventoryItems\": [\n {\n \"inventoryReferenceId\": \"\"\n }\n ],\n \"excludeListingIds\": [\n \"\"\n ],\n \"markupInventoryItems\": [\n {\n \"inventoryReferenceId\": \"\"\n }\n ],\n \"markupListingIds\": [\n \"\"\n ],\n \"selectionRules\": [\n {\n \"brands\": [\n \"\"\n ],\n \"categoryIds\": [\n \"\"\n ],\n \"categoryScope\": \"\",\n \"listingConditionIds\": [\n \"\"\n ],\n \"maxPrice\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"minPrice\": {\n \"currency\": \"\",\n \"value\": \"\"\n }\n }\n ]\n }\n },\n \"ruleOrder\": {{faker 'number.int' max=99999}}\n }\n ],\n \"startDate\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "24bf9f79-8024-43df-a23d-e11ea656691a", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "db9c9f0c-9095-405f-ad57-a784c28b868f", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "788fb558-fefa-4a32-ac33-1fe58476ad95", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5bdb892c-3863-425c-af29-1ccfa935ef59", "documentation": "This method updates the specified item price markdown promotion with the new configuration that you supply in the payload of the request. Specify the promotion you want to update using the promotion_id path parameter. Call getPromotions to retrieve the IDs of a seller's promotions. When updating a promotion, supply all the fields that you used to configure the original promotion (and not just the fields you are updating). eBay replaces the specified promotion with the values you supply in the update request and if you don't pass a field that currently has a value, the update request fails. The parameters you are allowed to update with this request depend on the status of the promotion you're updating: DRAFT or SCHEDULED promotions: You can update any of the parameters in these promotions that have not yet started to run, including the discountRules. RUNNING promotions: You can change the endDate and the item's inventory but you cannot change the promotional discount or the promotion's start date. ENDED promotions: Nothing can be changed.", "method": "put", "endpoint": "item_price_markdown/:promotion_id", "responses": [ { "uuid": "3369741b-d16b-4fbe-83c6-500d8601558e", "body": "{}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3bff9ab2-a4a4-4bc5-abee-f8b273557704", "body": "", "latency": 0, "statusCode": 204, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "46ec6d0a-a752-48b8-8677-1cc44f7b133a", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3f5aba57-f8a7-4171-8b27-eaeac1c9cf67", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "56634311-c8d6-4956-81ec-486b7862d974", "body": "", "latency": 0, "statusCode": 409, "label": "Business Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "e86c73a3-3d0d-481c-b35a-2f099c6229a8", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8b653298-da41-440b-8108-c76347fbee1f", "documentation": "This method creates an item promotion, where the buyer receives a discount when they meet the buying criteria that's set for the promotion. Known here as "threshold promotions", these promotions trigger when a threshold is met. eBay highlights promoted items by placing teasers for the promoted items throughout the online buyer flows. Discounts are specified as either a monetary amount or a percentage off the standard sales price of a listing, letting you offer deals such as "Buy 1 Get 1" and "Buy $50, get 20% off". Volume pricing promotions increase the value of the discount as the buyer increases the quantity they purchase. Coded Coupons provide unique codes that a buyer can use during checkout to receive a discount. The seller can specify the number of times a buyer can use the coupon and the maximum amount across all purchases that can be discounted using the coupon. The coupon code can also be made public (appearing on the seller’s Offer page, search pages, the item listing, and the checkout page) or private (only on the seller’s Offer page, but the seller can include the code in email and social media). Note: Coded Coupons are currently available in the US, UK, DE, FR, IT, ES, and AU marketplaces. There are two ways to add items to a threshold promotion: Key-based promotions select items using either the listing IDs or inventory reference IDs of the items you want to promote. Note that if you use inventory reference IDs, you must specify both the inventoryReferenceId and the associated inventoryReferenceType of the item(s) you want to include the promotion. Rule-based promotions select items using a list of eBay category IDs or seller Store category IDs. Rules can further constrain items in a promotion by minimum and maximum prices, brands, and item conditions. You must create a new promotion in either a DRAFT or SCHEDULED state. Use the DRAFT state when you are initially creating a promotion and you want to be sure it's correctly configured before scheduling it to run. When you create a promotion, the promotion ID is returned in the Location response header. Use this ID to reference the promotion in subsequent requests. Tip: Refer to the Selling Integration Guide for details and examples showing how to create and manage threshold promotions using the Promotions Manager. For information on the eBay marketplaces that support item promotions, see Promotions Manager requirements and restrictions.", "method": "post", "endpoint": "item_promotion", "responses": [ { "uuid": "e798789a-d35a-4e6f-94c5-08ec2c4bcf56", "body": "{\n \"warnings\": [\n {\n \"category\": \"\",\n \"domain\": \"\",\n \"errorId\": {{faker 'number.int' max=99999}},\n \"inputRefIds\": [\n \"\"\n ],\n \"longMessage\": \"\",\n \"message\": \"\",\n \"outputRefIds\": [\n \"\"\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"subdomain\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 201, "label": "Created", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Location", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "63a6104d-5281-42da-8ae4-98fb0e373d7a", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "3a7e0c8f-1bb5-44c6-8033-9d2aa2a5e0a8", "body": "", "latency": 0, "statusCode": 409, "label": "Business Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "5d3aa7b0-cd64-4b60-b9d8-803d81ab43e4", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3669a637-caed-4e77-911a-7043c0aecce2", "documentation": "This method deletes the threshold promotion specified by the promotion_id path parameter. Call getPromotions to retrieve the IDs of a seller's promotions. You can delete any promotion with the exception of those that are currently active (RUNNING). To end a running threshold promotion, call updateItemPromotion and adjust the endDate field as appropriate.", "method": "delete", "endpoint": "item_promotion/:promotion_id", "responses": [ { "uuid": "ce987e06-c027-4b57-aecd-75d3c53a575f", "body": "", "latency": 0, "statusCode": 204, "label": "No Content", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "b17e505f-48f7-4988-abe7-996a288a245c", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8b2d7b03-0cf7-480d-83a4-0754d148830c", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "caa98897-6520-482b-b578-b5ce485741cf", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2c2eb50b-7ac2-4aec-b727-c4832f29e2cf", "documentation": "This method returns the complete details of the threshold promotion specified by the promotion_id path parameter. Call getPromotions to retrieve the IDs of a seller's promotions.", "method": "get", "endpoint": "item_promotion/:promotion_id", "responses": [ { "uuid": "65320d82-3e06-44d8-a6dd-5b4e4a890118", "body": "{\n \"applyDiscountToSingleItemOnly\": {{faker 'datatype.boolean'}},\n \"budget\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"couponConfiguration\": {\n \"couponCode\": \"\",\n \"couponType\": \"\",\n \"maxCouponRedemptionPerUser\": {{faker 'number.int' max=99999}}\n },\n \"description\": \"\",\n \"discountRules\": [\n {\n \"discountBenefit\": {\n \"amountOffItem\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"amountOffOrder\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"percentageOffItem\": \"\",\n \"percentageOffOrder\": \"\"\n },\n \"discountSpecification\": {\n \"forEachAmount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"forEachQuantity\": {{faker 'number.int' max=99999}},\n \"minAmount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"minQuantity\": {{faker 'number.int' max=99999}},\n \"numberOfDiscountedItems\": {{faker 'number.int' max=99999}}\n },\n \"maxDiscountAmount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"ruleOrder\": {{faker 'number.int' max=99999}}\n }\n ],\n \"endDate\": \"\",\n \"inventoryCriterion\": {\n \"inventoryCriterionType\": \"\",\n \"inventoryItems\": [\n {\n \"inventoryReferenceId\": \"\"\n }\n ],\n \"listingIds\": [\n \"\"\n ],\n \"ruleCriteria\": {\n \"excludeInventoryItems\": [\n {\n \"inventoryReferenceId\": \"\"\n }\n ],\n \"excludeListingIds\": [\n \"\"\n ],\n \"markupInventoryItems\": [\n {\n \"inventoryReferenceId\": \"\"\n }\n ],\n \"markupListingIds\": [\n \"\"\n ],\n \"selectionRules\": [\n {\n \"brands\": [\n \"\"\n ],\n \"categoryIds\": [\n \"\"\n ],\n \"categoryScope\": \"\",\n \"listingConditionIds\": [\n \"\"\n ],\n \"maxPrice\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"minPrice\": {\n \"currency\": \"\",\n \"value\": \"\"\n }\n }\n ]\n }\n },\n \"marketplaceId\": \"\",\n \"name\": \"\",\n \"priority\": \"\",\n \"promotionId\": \"\",\n \"promotionImageUrl\": \"\",\n \"promotionStatus\": \"\",\n \"promotionType\": \"\",\n \"startDate\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "9ccd9510-f135-4b7a-99a6-d23a6e78c3a5", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "993a691c-ee31-4d69-a001-c4df5c7b1034", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "86b7b7ea-54a5-438e-ae12-e0b92f12795d", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b94adc77-ede0-4e6a-817d-7fc654c01b8a", "documentation": "This method updates the specified threshold promotion with the new configuration that you supply in the request. Indicate the promotion you want to update using the promotion_id path parameter. Call getPromotions to retrieve the IDs of a seller's promotions. When updating a promotion, supply all the fields that you used to configure the original promotion (and not just the fields you are updating). eBay replaces the specified promotion with the values you supply in the update request and if you don't pass a field that currently has a value, the update request will fail. The parameters you are allowed to update with this request depend on the status of the promotion you're updating: DRAFT or SCHEDULED promotions: You can update any of the parameters in these promotions that have not yet started to run, including the discountRules. RUNNING or PAUSED promotions: You can change the endDate and the item's inventory but you cannot change the promotional discount or the promotion's start date. ENDED promotions: Nothing can be changed. Tip: When updating a RUNNING or PAUSED promotion, set the status field to SCHEDULED for the update request. When the promotion is updated, the previous status (either RUNNING or PAUSED) is retained.", "method": "put", "endpoint": "item_promotion/:promotion_id", "responses": [ { "uuid": "43ed94c1-190f-43ca-b72f-8df9751fc429", "body": "{\n \"warnings\": [\n {\n \"category\": \"\",\n \"domain\": \"\",\n \"errorId\": {{faker 'number.int' max=99999}},\n \"inputRefIds\": [\n \"\"\n ],\n \"longMessage\": \"\",\n \"message\": \"\",\n \"outputRefIds\": [\n \"\"\n ],\n \"parameters\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ],\n \"subdomain\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3f9efa80-e333-4fa6-8f21-387dbbcfdc81", "body": "", "latency": 0, "statusCode": 204, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6d800a89-b8d7-45ba-a255-e9d29981f3b4", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d95a7862-b74f-4821-8b72-ff59bdedddcf", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ab3b2b91-fd4d-493a-91fb-ba39e7cbdee1", "body": "", "latency": 0, "statusCode": 409, "label": "Business Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "00440012-d961-4ad0-9a4c-579a2e0d2ad8", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "86dbf045-268b-4257-98e5-5f47aa144e46", "documentation": "This method returns a list of a seller's undeleted promotions. The call returns up to 200 currently-available promotions on the specified marketplace. While the response body does not include the promotion's discountRules or inventoryCriterion containers, it does include the promotionHref (which you can use to retrieve the complete details of the promotion). Use query parameters to sort and filter the results by the number of promotions to return, the promotion state or type, and the eBay marketplace. You can also supply keywords to limit the response to the promotions that contain that keywords in the title of the promotion. Maximum returned: 200", "method": "get", "endpoint": "promotion", "responses": [ { "uuid": "acaf021f-98be-4766-9154-df805167d590", "body": "{\n \"href\": \"\",\n \"limit\": {{faker 'number.int' max=99999}},\n \"next\": \"\",\n \"offset\": {{faker 'number.int' max=99999}},\n \"prev\": \"\",\n \"promotions\": [\n {\n \"couponCode\": \"\",\n \"description\": \"\",\n \"endDate\": \"\",\n \"marketplaceId\": \"\",\n \"name\": \"\",\n \"priority\": \"\",\n \"promotionHref\": \"\",\n \"promotionId\": \"\",\n \"promotionImageUrl\": \"\",\n \"promotionStatus\": \"\",\n \"promotionType\": \"\",\n \"startDate\": \"\"\n }\n ],\n \"total\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "0ece62df-3233-49f0-a19f-a40ebe191b56", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a48acbf6-d13f-4668-b3ac-0023649d7a8a", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "07e20169-9efc-4b18-bba3-271f07ad49df", "documentation": "This method returns the set of listings associated with the promotion_id specified in the path parameter. Call getPromotions to retrieve the IDs of a seller's promotions. The listing details are returned in a paginated set and you can control and results returned using the following query parameters: limit, offset, q, sort, and status. Maximum associated listings returned: 200 Default number of listings returned: 200", "method": "get", "endpoint": "promotion/:promotion_id/get_listing_set", "responses": [ { "uuid": "3f22e702-4b6e-4fc3-82d9-99786d65c7f1", "body": "", "latency": 0, "statusCode": 204, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "83955411-123f-45d8-90c8-347402ef2986", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "2b24b429-a2dc-4ec9-9fae-50ef923b3f15", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "593d8d2b-8412-4892-bd10-db0cb4c7404f", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "642a386b-7a6d-403e-acab-90ef7ea3957f", "documentation": "This method pauses a currently-active (RUNNING) threshold promotion and changes the state of the promotion from RUNNING to PAUSED. Pausing a promotion makes the promotion temporarily unavailable to buyers and any currently-incomplete transactions will not receive the promotional offer until the promotion is resumed. Also, promotion teasers are not displayed when a promotion is paused. Pass the ID of the promotion you want to pause using the promotion_id path parameter. Call getPromotions to retrieve the IDs of the seller's promotions. Note: You can only pause threshold promotions (you cannot pause markdown promotions).", "method": "post", "endpoint": "promotion/:promotion_id/pause", "responses": [ { "uuid": "16aa06a9-c2bf-475d-9865-6ae6d4e0aac3", "body": "", "latency": 0, "statusCode": 204, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "981cd320-b61c-457f-86d3-b363aa243b5b", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "58b3dbfb-3929-4f58-8d8d-2f07a5af2316", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "c3e9f065-ccef-487d-8db2-b496ca3ced91", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f2889a21-7f8b-4ceb-9f2b-02e8bfa94e34", "documentation": "This method restarts a threshold promotion that was previously paused and changes the state of the promotion from PAUSED to RUNNING. Only promotions that have been previously paused can be resumed. Resuming a promotion reinstates the promotional teasers and any transactions that were in motion before the promotion was paused will again be eligible for the promotion. Pass the ID of the promotion you want to resume using the promotion_id path parameter. Call getPromotions to retrieve the IDs of the seller's promotions.", "method": "post", "endpoint": "promotion/:promotion_id/resume", "responses": [ { "uuid": "4a01d5c1-0447-475d-8f58-e56c41391d0a", "body": "", "latency": 0, "statusCode": 204, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c3a96e49-6f59-4dc4-81f0-c22442d86357", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "d352c812-df52-45ac-b789-45f32c8bd3ad", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4e54f098-486a-4f83-8666-d9bbfeae49ff", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e843205c-ae03-442e-a3b4-2f86bacb62a2", "documentation": "This method generates a report that lists the seller's running, paused, and ended promotions for the specified eBay marketplace. The result set can be filtered by the promotion status and the number of results to return. You can also supply keywords to limit the report to promotions that contain the specified keywords. Specify the eBay marketplace for which you want the report run using the marketplace_id query parameter. Supply additional query parameters to control the report as needed.", "method": "get", "endpoint": "promotion_report", "responses": [ { "uuid": "e5d379e2-4182-492b-9924-fe23ed6b0085", "body": "{\n \"href\": \"\",\n \"limit\": {{faker 'number.int' max=99999}},\n \"next\": \"\",\n \"offset\": {{faker 'number.int' max=99999}},\n \"prev\": \"\",\n \"promotionReports\": [\n {\n \"averageItemDiscount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"averageItemRevenue\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"averageOrderDiscount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"averageOrderRevenue\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"averageOrderSize\": \"\",\n \"baseSale\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"itemsSoldQuantity\": {{faker 'number.int' max=99999}},\n \"numberOfOrdersSold\": {{faker 'number.int' max=99999}},\n \"percentageSalesLift\": \"\",\n \"promotionHref\": \"\",\n \"promotionId\": \"\",\n \"promotionReportId\": \"\",\n \"promotionSale\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"promotionType\": \"\",\n \"totalDiscount\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"totalSale\": {\n \"currency\": \"\",\n \"value\": \"\"\n }\n }\n ],\n \"total\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bb390be9-4bf5-4051-830e-93c737a2f3da", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a0825bd8-0a90-4aea-9173-2fda880454c1", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d41e479e-f7d6-4d65-849d-ae324f38e5ef", "documentation": "This method generates a report that summarizes the seller's promotions for the specified eBay marketplace. The report returns information on RUNNING, PAUSED, and ENDED promotions (deleted reports are not returned) and summarizes the seller's campaign performance for all promotions on a given site. For information about summary reports, see Reading the item promotion Summary report.", "method": "get", "endpoint": "promotion_summary_report", "responses": [ { "uuid": "ebda06d3-f602-4298-a0cd-af1574a01d67", "body": "{\n \"baseSale\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"lastUpdated\": \"\",\n \"percentageSalesLift\": \"\",\n \"promotionSale\": {\n \"currency\": \"\",\n \"value\": \"\"\n },\n \"totalSale\": {\n \"currency\": \"\",\n \"value\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5d4677d7-fa4d-4333-b39b-7ea83cbeb046", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "89b8239d-d257-4985-ad23-690961a20c62", "body": "", "latency": 0, "statusCode": 404, "label": "Not Found", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a883f3fb-9555-4521-be9c-53956733e5c2", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "0991180d-ca26-4a6d-8151-6bdc66ca30db" }, { "type": "route", "uuid": "cb3f4acf-0799-4c07-8378-f38232590e86" }, { "type": "route", "uuid": "de9d18f8-e238-4786-ae53-2428ef345774" }, { "type": "route", "uuid": "63792bf4-134e-48f2-b367-73c6ba48945c" }, { "type": "route", "uuid": "94dacf29-63fd-4d3f-a473-d19dc64966b5" }, { "type": "route", "uuid": "44d8fab9-1a35-4a3e-be6c-49a5898c81dd" }, { "type": "route", "uuid": "5250c7b9-deed-4892-8095-58ef2b7cfb1c" }, { "type": "route", "uuid": "ab564f8f-9d95-43bb-8bae-ded9e8925701" }, { "type": "route", "uuid": "07213196-d7ee-4c78-bac5-6a988f070499" }, { "type": "route", "uuid": "9b4a9d6b-869c-4525-a978-2460f9e3856d" }, { "type": "route", "uuid": "82f530ee-5cdf-447d-8501-77fdbf46f120" }, { "type": "route", "uuid": "5afb0e6e-e702-4225-b062-ca540d86fadc" }, { "type": "route", "uuid": "1a3831de-5419-4cc2-9120-fc6a78ae4e1a" }, { "type": "route", "uuid": "1ced1fbd-06f6-4ffe-8bf8-770dc9eaf1f0" }, { "type": "route", "uuid": "6bbc248f-9e67-4726-9bdc-e2b6d7895e4a" }, { "type": "route", "uuid": "20bbcaed-aec1-4357-929f-5f3e89da0693" }, { "type": "route", "uuid": "e1ee3c15-fa4d-41f5-a5be-ff39531c38ff" }, { "type": "route", "uuid": "1761ea69-c051-462f-88f2-998615ea7481" }, { "type": "route", "uuid": "1fd58071-f08f-435a-a27b-66824fd35c70" }, { "type": "route", "uuid": "abf66c13-1673-4bc6-a890-ec6319816505" }, { "type": "route", "uuid": "a24b5c1a-a211-429c-a8c0-872e3c570508" }, { "type": "route", "uuid": "33b80b9e-7e90-4100-af1e-741dfc1a922a" }, { "type": "route", "uuid": "e23550e8-4239-4ace-ba87-2296c935574a" }, { "type": "route", "uuid": "24b3cc11-4151-4961-b0b9-de4c9b920281" }, { "type": "route", "uuid": "18b86596-1042-43d8-afef-9163ddd08109" }, { "type": "route", "uuid": "e8872618-4aaa-4f10-85dc-f7abd6b79c94" }, { "type": "route", "uuid": "f6ef2ecd-fbed-492c-9a5f-2a433ebe7dcf" }, { "type": "route", "uuid": "1fda4f1b-ce5b-48bd-bc4e-9da78fdcc310" }, { "type": "route", "uuid": "c0e5f71f-7803-4a42-a836-c63bba2c2477" }, { "type": "route", "uuid": "6d01e75b-c5f5-4901-b550-ae63d70c4deb" }, { "type": "route", "uuid": "283cd3a6-08c0-4b87-960f-8162605a284b" }, { "type": "route", "uuid": "3fe7be85-dea9-4e7e-b81b-2e34e839e1b4" }, { "type": "route", "uuid": "b791e1dd-cdbc-46f9-9958-65248c8801d4" }, { "type": "route", "uuid": "77bbc833-f7a6-4c21-ae89-f297ab9576f4" }, { "type": "route", "uuid": "0db86d28-0377-4797-9bd5-83959c46cb0e" }, { "type": "route", "uuid": "5bdb892c-3863-425c-af29-1ccfa935ef59" }, { "type": "route", "uuid": "8b653298-da41-440b-8108-c76347fbee1f" }, { "type": "route", "uuid": "3669a637-caed-4e77-911a-7043c0aecce2" }, { "type": "route", "uuid": "2c2eb50b-7ac2-4aec-b727-c4832f29e2cf" }, { "type": "route", "uuid": "b94adc77-ede0-4e6a-817d-7fc654c01b8a" }, { "type": "route", "uuid": "86dbf045-268b-4257-98e5-5f47aa144e46" }, { "type": "route", "uuid": "07e20169-9efc-4b18-bba3-271f07ad49df" }, { "type": "route", "uuid": "642a386b-7a6d-403e-acab-90ef7ea3957f" }, { "type": "route", "uuid": "f2889a21-7f8b-4ceb-9f2b-02e8bfa94e34" }, { "type": "route", "uuid": "e843205c-ae03-442e-a3b4-2f86bacb62a2" }, { "type": "route", "uuid": "d41e479e-f7d6-4d65-849d-ae324f38e5ef" } ] }