{ "uuid": "b2f8aea5-c1a9-4929-a87e-002c09e3ea44", "lastMigration": 29, "name": "Compliance API", "endpointPrefix": "sell/compliance/v1", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "708a851b-8ca1-4d01-8fcd-a0eba0b349fe", "documentation": "This call returns specific listing violations for the supported listing compliance types. Only one compliance type can be passed in per call, and the response will include all the listing violations for this compliance type, and listing violations are grouped together by eBay listing ID. See ComplianceTypeEnum for more information on the supported listing compliance types. This method also has pagination control. Note: A maximum of 2000 listing violations will be returned in a result set. If the seller has more than 2000 listing violations, some/all of those listing violations must be corrected before additional listing violations will be retrieved. The user should pay attention to the total value in the response. If this value is '2000', it is possible that the seller has more than 2000 listing violations, but this field maxes out at 2000. Note: In a future release of this API, the seller will be able to pass in a specific eBay listing ID as a query parameter to see if this specific listing has any violations. Note: Only mocked non-compliant listing data will be returned for this call in the Sandbox environment, and not specific to the seller. However, the user can still use this mock data to experiment with the compliance type filters and pagination control.", "method": "get", "endpoint": "listing_violation", "responses": [ { "uuid": "53db9470-e0da-4507-8986-b2d27ceec3ac", "body": "{\n \"href\": \"\",\n \"limit\": {{faker 'number.int' max=99999}},\n \"listingViolations\": [\n {\n \"complianceType\": \"\",\n \"listingId\": \"\",\n \"offerId\": \"\",\n \"sku\": \"\",\n \"violations\": [\n {\n \"complianceState\": \"\",\n \"correctiveRecommendations\": {\n \"aspectRecommendations\": [\n {\n \"localizedAspectName\": \"\",\n \"suggestedValues\": [\n \"\"\n ]\n }\n ],\n \"productRecommendation\": {\n \"epid\": \"\"\n }\n },\n \"message\": \"\",\n \"reasonCode\": \"\",\n \"variation\": {\n \"sku\": \"\",\n \"variationAspects\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n },\n \"violationData\": [\n {\n \"name\": \"\",\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n ],\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;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ff671d79-32cf-4047-927f-506d7ee85198", "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": false, "crudKey": "id" }, { "uuid": "cef8931e-2988-4e16-a3f4-0a42fbdc381a", "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": "37df1fd4-7cb1-4652-9b6c-a86bbdce4343", "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": "96969806-b872-4b38-96b2-40a533f7e3a3", "documentation": "This call returns listing violation counts for a seller. A user can pass in one or more compliance types through the compliance_type query parameter. See ComplianceTypeEnum for more information on the supported listing compliance types. Listing violations are returned for multiple marketplaces if the seller sells on multiple eBay marketplaces. Note: Only a canned response, with counts for all listing compliance types, is returned in the Sandbox environment. Due to this limitation, the compliance_type query parameter (if used) will not have an effect on the response.", "method": "get", "endpoint": "listing_violation_summary", "responses": [ { "uuid": "e42f0599-f2cd-4568-98b1-cb059ffb3ca8", "body": "{\n \"violationSummaries\": [\n {\n \"complianceType\": \"\",\n \"listingCount\": {{faker 'number.int' max=99999}},\n \"marketplaceId\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [ { "key": "Content-Type", "value": "application/json;charset=UTF-8" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "23b9414d-fc50-44b7-b918-5ac067a28422", "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": false, "crudKey": "id" }, { "uuid": "5972bffc-3429-464d-906e-d54bd946be1b", "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": "48ec46b0-ed82-4af0-bbcb-1615f6bf36c7", "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": "ea124863-ddea-4fc9-a6ac-7852434b5015", "documentation": "This call suppresses a listing violation for a specific listing. Only listing violations in the AT_RISK state (returned in the violations.complianceState field of the getListingViolations call) can be suppressed. Note: At this time, the suppressViolation call only supports the suppressing of ASPECTS_ADOPTION listing violations in the AT_RISK state. In the future, it is possible that this method can be used to suppress other listing violation types. A successful call returns a http status code of 204 Success. There is no response payload. If the call is not successful, an error code will be returned stating the issue.", "method": "post", "endpoint": "suppress_listing_violation", "responses": [ { "uuid": "4d3e6f8d-30f4-4107-8605-d25f0a331653", "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": "b7125333-e95c-4ff7-abcc-619c24f03034", "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": "35b662df-9caa-43c9-96ba-6e83861830df", "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": "8b5ca0d0-91f1-43bf-90a7-0a27a6b44f4f", "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": "708a851b-8ca1-4d01-8fcd-a0eba0b349fe" }, { "type": "route", "uuid": "96969806-b872-4b38-96b2-40a533f7e3a3" }, { "type": "route", "uuid": "ea124863-ddea-4fc9-a6ac-7852434b5015" } ] }