openapi: 3.0.0
info:
contact:
email: partner-api@wish.com
x-wish-dev-contact:
assignee: kwei
email: marketplace-external-api@contextlogic.com
description: "\nWish Marketplace V3 API\n\n# General Information\n\n The Wish Marketplace API will be using oAuth to authenticate in order to offer better security for its users\n\n * Learn about oAuth [here](oauth).\n * If you are a merchant and want to create an application for yourself, learn about how to create a private app [here](../../private-app)\n * If you are a ERP and create applications that'll be used by multiple merchants, learn about how to create a public app [here]( ../../public-app). You will need to apply to be a verified public application\n\n ## How to Test\n\n To avoid testing the API on production data, use our sandbox. The sandbox is completely contained and will not affect Wish users or your merchant account. \n \n To reach the sandbox, visit: https://sandbox.merchant.wish.com.\n\n To use the sandbox in testing, use https://sandbox.merchant.wish.com/api/v3/ as your base URL.\n\n How to Generate test data after you have created a sandbox account:\n 1. Navigate to the [unfulfilled orders page](https://sandbox.merchant.wish.com/transactions/action)\n 2. Hover over the dropdown next to the 'fulfill with csv' button and select Generate Orders\n\n ## Date/Time Format\n\n All dates and times in our API are returned in the same format. It is in the form `YYYY-MM-DDTHH:mm:ss.sss±XX:ZZ` or `YYYY-MM-DDTHH:mm:ss.sssZ`, where 'Z' represents UTC timezone.\n When sending timestamps in URL parameters or the request body, millisecond is optional and will defaults to 0 if not provided.\n\n * `YYYY` is the year\n * `MM` is the month\n * `DD` is the day\n * `HH` is the hour (in 24-hour clock format)\n * `mm` is the minutes\n * `ss.sss` is the seconds and milliseconds\n * `±XX:ZZ` is the UTC offset of the form +XX:ZZ or -XX:ZZ where XX is a 2-digit string giving the number of UTC offset hours, and ZZ is a 2-digit string giving the number of UTC offset minutes.\n\n ## Response Schema\n\n Every response returned from the Wish API will have the same schema. This schema is intended to give you a predictable manner to check the status of your request and know where to get the data. Each response will have the following top level attributes: message, code and data.\n\n **Attributes**\n\n <table>\n <tbody>\n <tr>\n <th>Message</th>\n <td>A message describing the error that happened, example: \"We could not find a product for id: '5d30f60e0a6fc464f4f376b0'\"</td>\n </tr>\n <tr>\n <th>Code</th>\n <td>A unique number which represents the error that has occurred, example: 1008 or 0 if success.</td>\n </tr>\n <tr>\n <th>Data</th>\n <td>For errors this will be empty.</td>\n </tr>\n </tbody>\n </table>\n\n ## General Querying Techniques\n\n ### Partial Resources\n All GET endpoints (except OAuth) support a fields parameter which allows for requesting a partial response. Any fields specified in the response schema of an endpoint can be selected. The top level attribute `data` can be ignored when using the fields parameter.\n\n **Syntax**\n * Comma-separated list to select multiple fields\n * Use forward slash `/` to select nested field: `field1/nested_field`\n * Use parentheses `( )` to select multiple nested fields: `field1(nested_field1,nested_field2)`\n * Use `*` for wildcard selection: `field1/nested_field/*`\n\n\n **Example:**\n ```\n https://merchant.wish.com/api/v3/demo/get?fields=title,items(id,info/name)\n ```\n Which would result in the following partial response:\n ```\n {\n \"title\": \"demo\",\n \"items\": [\n {\n \"id\": \"1\",\n \"info\": {\n \"name\": \"demo_item_1\"\n }\n }, {\n \"id\": \"2\",\n \"info\": {\n \"name\": \"demo_item_2\"\n }\n },\n ...\n ]\n }\n ```\n\n ## Locale\n You can optionally specify locale in order to translate content and error messages into your language.\n To do this use the [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language) header to specify your preferred locales.\n If none is provided, your default locale will be used.\n\n For example, to request content in Chinese use: `Accept-Language: zh`\n\n In the response, you will receive a [Content-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Language) header that specifies the locale code of the response content.\n\n\n ## Rate-Limiting\n\n Rate-limiting will be performed on a per-merchant basis for each app. It is your responsibility to ensure you are not making frequent unnecessary calls to the API.\n\n If the rate limits cannot satisfy your need, we highly recommend integrating webhooks for your app. With webhooks, instead of pulling resources periodically, your app will receive real-time notifications for particular events that occur to a merchant’s store. [Learn more](https://merchant.wish.com/documentation/webhooks)\n\n **Normal Usage**\n\n To help you track the rate-limiter status, the following response header(s) will be provided with each response:\n\n * `Wish-Rate-Limit-Remaining`: The number of calls remaining in the current rate-limiting window.\n\n\n **Rate-Limit Exceeded**\n\n After you exceed the number of allowed calls in the current rate-limiting window, you will receive a `429 Too Many Requests` error response and the following additional header(s):\n\n * `Wish-Rate-Limit-Reset`: The time the rate-limiter will reset.\n\n\n Once you receive this response there is nothing you can do except wait for the rate-limiter to reset. In order to avoid being rate-limited, you may want to cache your responses.\n\n ## Sorting\n ### Overview\n Sorting is available for most endpoints that return a collection (list) of objects. Each collection has a different set of enabled parameters for sorting, so please check specific collection section for detail.\n\n ### Usage\n Append `sort_by={parameter_name}.{asc|desc}` in your API request where `parameter_name` is a valid sortable parameter of that endpoint.\n\n Example:\n ```\n /api/v3/penalties?sort_by=created_at.asc\n ```\n\n ## Pagination\n All bulk-fetching API methods that return lists of resource support pagination.\n These methods commonly take at least 3 parameters: `limit`, `{attribute}_min`, `{attribute}_max`. Attribute can be `id`, `create_at`, etc., depending on each specific method.\n For instance, you make a request to get a list of penalties `/api/v3/penalties?limit=20&created_at_max=2020-04-08T23:59:59Z&sort_by=created_at_max.desc`,\n which means to fetch 20 penalities sorted by their creation time, with the most recent one being created before `2020-04-08T23:59:59Z`.\n Assume that the response contains 20 `penalty` objects with the last object being `penalty_foo`,\n then your subsequent request can be `/api/v3/penalties?limit=20&created_at_max={penalty_foo.create_at}&sort_by=created_at_max.desc` to fetch the next page of list.\n Note that when fetching next page using `id_min` or `id_max`, you need to perform `+/- 1`(correspondingly) on the last object's ID in the current page, as `id_min` and `id_max` are inclusive. (All V3 API resources' IDs are either integer or BSON object ID - a hex number).\n\n\n ## Request ID\n Each API request is associated with a unique identifier. You can find this value in response headers, under `Wish-Request-Id`.\n **When you need to contact us about a specific request, please provide this ID to ensure the fastest possible reply**\n\n# Authentication\nFor all requests that require OAuth2 authentication, the access token must be provided in the `Authorization` request header in the following format: `Authorization: Bearer <token>`\n\nFor example:\n```\nAuthorization: Bearer 3d6e2d71bc464e42bfbdb081afb73c1e\n```\n<!-- ReDoc-Inject: <security-definitions> -->\n"
version: 3.0.65
title: Wish Marketplace V3 Brands Germany EPR Compliance API
servers:
- url: https://merchant.wish.com
description: V3 API endpoint
security:
- OAuth2: []
tags:
- description: 'APIs that support Germany Extended Producer Responsibility (EPR) Compliance.</br> For a merchant to be compliant with the EPR regulation, their applicable products must be linked with one or more EPR registration number. '
name: Germany EPR Compliance
paths:
/api/v3/germany_epr_compliance/epr_registration_number:
post:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GermanyProductEprRegistrationNumberResponse'
description: Successfully created a new Germany product EPR registration number.
'400':
content:
application/json:
examples:
ExtAPIEprRegistrationNumberExceedLimitException:
value:
message: The category exceeds the limit of 1 EPR number per category on the operated merchant.
code: '10002'
ExtAPIEprRegistrationNumberMissingProException:
value:
message: The product responsibility organization input is mandatory for this category.
code: '10008'
ExtAPIEprRegistrationNumberInvalidFieldException:
value:
message: The input EPR registration number has invalid fields.
code: '10001'
schema:
$ref: '#/components/schemas/APIError'
description: Failed to create a new Germany product EPR registration number.
tags:
- Germany EPR Compliance
summary: Create a Germany Product EPR Registration Number
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateGermanyProductEprRegistrationNumber'
security:
- OAuth2:
- compliance:write
operationId: createGermanyProductEprRegistrationNumber
x-code-samples:
- lang: python_requests
source: "import requests\n\nurl = \"https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number\"\n\npayload = \"{\\\"category\\\":\\\"BATTERIES\\\",\\\"epr_number\\\":\\\"string\\\",\\\"organization_or_representative_name\\\":\\\"string\\\"}\"\nheaders = {\n 'content-type': \"application/json\",\n 'authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nresponse = requests.request(\"POST\", url, data=payload, headers=headers)\n\nprint(response.text)"
- lang: javascript_jquery
source: "var settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number\",\n \"method\": \"POST\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n },\n \"processData\": false,\n \"data\": \"{\\\"category\\\":\\\"BATTERIES\\\",\\\"epr_number\\\":\\\"string\\\",\\\"organization_or_representative_name\\\":\\\"string\\\"}\"\n}\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});"
- lang: php_curl
source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n CURLOPT_URL => \"https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"POST\",\n CURLOPT_POSTFIELDS => \"{\\\"category\\\":\\\"BATTERIES\\\",\\\"epr_number\\\":\\\"string\\\",\\\"organization_or_representative_name\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => array(\n \"authorization: Bearer REPLACE_BEARER_TOKEN\",\n \"content-type: application/json\"\n ),\n));\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"
- lang: shell_curl
source: "curl --request POST \\\n --url 'https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number' \\\n --header 'authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"category\":\"BATTERIES\",\"epr_number\":\"string\",\"organization_or_representative_name\":\"string\"}'"
- lang: java_unirest
source: "HttpResponse<String> response = Unirest.post(\"https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number\")\n .header(\"content-type\", \"application/json\")\n .header(\"authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .body(\"{\\\"category\\\":\\\"BATTERIES\\\",\\\"epr_number\\\":\\\"string\\\",\\\"organization_or_representative_name\\\":\\\"string\\\"}\")\n .asString();"
description: Create a Germany Product EPR Registration Number
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListGermanyProductEprRegistrationNumbersResponse'
description: Successfully queried all Germany EPR registration numbers.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: Failed to query for Germany EPR registration numbers.
tags:
- Germany EPR Compliance
description: List all Germany product EPR numbers and their product categories created by a merchant.
summary: List Germany EPR Registration Numbers
security:
- OAuth2:
- compliance:read
x-code-samples:
- lang: python_requests
source: 'import requests
url = "https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number"
headers = {''authorization'': ''Bearer REPLACE_BEARER_TOKEN''}
response = requests.request("GET", url, headers=headers)
print(response.text)'
- lang: javascript_jquery
source: "var settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number\",\n \"method\": \"GET\",\n \"headers\": {\n \"authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n}\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});"
- lang: php_curl
source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n CURLOPT_URL => \"https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => array(\n \"authorization: Bearer REPLACE_BEARER_TOKEN\"\n ),\n));\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"
- lang: shell_curl
source: "curl --request GET \\\n --url 'https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number' \\\n --header 'authorization: Bearer REPLACE_BEARER_TOKEN'"
- lang: java_unirest
source: "HttpResponse<String> response = Unirest.get(\"https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number\")\n .header(\"authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"
operationId: listGermanyProductEprRegistrationNumbers
/api/v3/germany_epr_compliance/compliance_status:
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GermanyProductComplianceStatusResponse'
description: Successfully updated Germany product compliance status for input products.
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIError'
description: Failed to update Germany product compliance status for input products.
tags:
- Germany EPR Compliance
summary: Bulk update Germany EPR Product Compliance Status
requestBody:
content:
application/json:
schema:
items:
$ref: '#/components/schemas/GermanyProductComplianceStatusRequest'
type: array
description: List of product ids associated with update request on Germany EPR Product Compliance Status
maxItems: 500
security:
- OAuth2:
- compliance:write
operationId: updateGermanyEPRProductComplianceStatus
x-code-samples:
- lang: python_requests
source: "import requests\n\nurl = \"https://merchant.wish.com/api/v3/germany_epr_compliance/compliance_status\"\n\npayload = \"[{\\\"epr_registration_number_id\\\":\\\"string\\\",\\\"product_id\\\":\\\"string\\\"}]\"\nheaders = {\n 'content-type': \"application/json\",\n 'authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nresponse = requests.request(\"PUT\", url, data=payload, headers=headers)\n\nprint(response.text)"
- lang: javascript_jquery
source: "var settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://merchant.wish.com/api/v3/germany_epr_compliance/compliance_status\",\n \"method\": \"PUT\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n },\n \"processData\": false,\n \"data\": \"[{\\\"epr_registration_number_id\\\":\\\"string\\\",\\\"product_id\\\":\\\"string\\\"}]\"\n}\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});"
- lang: php_curl
source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n CURLOPT_URL => \"https://merchant.wish.com/api/v3/germany_epr_compliance/compliance_status\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"PUT\",\n CURLOPT_POSTFIELDS => \"[{\\\"epr_registration_number_id\\\":\\\"string\\\",\\\"product_id\\\":\\\"string\\\"}]\",\n CURLOPT_HTTPHEADER => array(\n \"authorization: Bearer REPLACE_BEARER_TOKEN\",\n \"content-type: application/json\"\n ),\n));\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"
- lang: shell_curl
source: "curl --request PUT \\\n --url 'https://merchant.wish.com/api/v3/germany_epr_compliance/compliance_status' \\\n --header 'authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '[{\"epr_registration_number_id\":\"string\",\"product_id\":\"string\"}]'"
- lang: java_unirest
source: "HttpResponse<String> response = Unirest.put(\"https://merchant.wish.com/api/v3/germany_epr_compliance/compliance_status\")\n .header(\"content-type\", \"application/json\")\n .header(\"authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .body(\"[{\\\"epr_registration_number_id\\\":\\\"string\\\",\\\"product_id\\\":\\\"string\\\"}]\")\n .asString();"
description: Update the Germany Extended Producer Responsibility compliance status for each input product by linking with the associated input epr_id or unlinking the existing EPR number if the associated input epr_id is empty or null.</br> The input array size limitation is 500.
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GermanyProductComplianceStatusResponse'
description: Successfully queried for product compliance status.
'400':
content:
application/json:
examples:
ExtAPIEprRegistrationNumberNotFoundException:
value:
message: The input Germany product EPR registration number is not found by the given id.
code: '10003'
schema:
$ref: '#/components/schemas/APIError'
description: Failed to query for product compliance status.
parameters:
- in: query
description: The list of the product IDs that will be returned with the compliance status
name: product_ids
schema:
items:
type: string
description: The unique identifiers of a product
format: object-id
type: array
maxItems: 500
- required: false
in: query
description: The beginning product id(inclusive) of the result array. If not provided, will use the smallest product id.</br> Ignored when `product_ids` is provided.
name: product_id_min
schema:
type: string
format: object-id
- required: false
in: query
description: The ending product id(inclusive) of the result array. If not provided, will use the largest product id.</br> Ignored when `product_ids` is provided.
name: product_id_max
schema:
type: string
format: object-id
- in: query
description: A limit on the number of records that will be returned.</br> Ignored when `product_ids` is provided.
name: limit
schema:
default: 100
minimum: 0
type: integer
maximum: 500
- in: query
description: Sort results by the given attribute. Enabled attributes are `product_id`. Default order is `asc`, use `desc` to sort in reverse.</br> Ignored when `product_ids` is provided.
name: sort_by
schema:
default: product_id.asc
pattern: ^product_id(\.(asc|desc))?$
type: string
tags:
- Germany EPR Compliance
summary: Get Germany EPR Product Compliance Status
security:
- OAuth2:
- compliance:read
operationId: getGermanyEPRProductComplianceStatus
x-code-samples:
- lang: python_requests
source: 'import requests
url = "https://merchant.wish.com/api/v3/germany_epr_compliance/compliance_status"
querystring = {"product_ids":"SOME_ARRAY_VALUE","product_id_min":"SOME_STRING_VALUE","product_id_max":"SOME_STRING_VALUE","limit":"SOME_INTEGER_VALUE","sort_by":"SOME_STRING_VALUE"}
headers = {''authorization'': ''Bearer REPLACE_BEARER_TOKEN''}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)'
- lang: javascript_jquery
source: "var settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://merchant.wish.com/api/v3/germany_epr_compliance/compliance_status?product_ids=SOME_ARRAY_VALUE&product_id_min=SOME_STRING_VALUE&product_id_max=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&sort_by=SOME_STRING_VALUE\",\n \"method\": \"GET\",\n \"headers\": {\n \"authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n}\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});"
- lang: php_curl
source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n CURLOPT_URL => \"https://merchant.wish.com/api/v3/germany_epr_compliance/compliance_status?product_ids=SOME_ARRAY_VALUE&product_id_min=SOME_STRING_VALUE&product_id_max=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&sort_by=SOME_STRING_VALUE\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => array(\n \"authorization: Bearer REPLACE_BEARER_TOKEN\"\n ),\n));\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"
- lang: shell_curl
source: "curl --request GET \\\n --url 'https://merchant.wish.com/api/v3/germany_epr_compliance/compliance_status?product_ids=SOME_ARRAY_VALUE&product_id_min=SOME_STRING_VALUE&product_id_max=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&sort_by=SOME_STRING_VALUE' \\\n --header 'authorization: Bearer REPLACE_BEARER_TOKEN'"
- lang: java_unirest
source: "HttpResponse<String> response = Unirest.get(\"https://merchant.wish.com/api/v3/germany_epr_compliance/compliance_status?product_ids=SOME_ARRAY_VALUE&product_id_min=SOME_STRING_VALUE&product_id_max=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&sort_by=SOME_STRING_VALUE\")\n .header(\"authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .asString();"
description: Get the Germany Extended Producer Responsibility product compliance status and the EPR registration number ids (if linked) for each input product.</br> If there is no input product id, then get the result of all products from a merchant.</br> The EPR registration id will be empty for products that are not linked with any EPR registration number.
/api/v3/germany_epr_compliance/epr_registration_number/{id}:
put:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GermanyProductEprRegistrationNumberResponse'
description: Successfully updated a Germany product EPR registration number.
'400':
content:
application/json:
examples:
ExtAPIEprRegistrationNumberNoAccessException:
value:
message: The Germany product EPR registration number is not accessable for the operated merchant.
code: '10004'
ExtAPIEprRegistrationNumberNotFoundException:
value:
message: The input Germany product EPR registration number is not found by the given id.
code: '10003'
ExtAPIEprRegistrationNumberInvalidFieldException:
value:
message: The input EPR registration number has invalid fields.
code: '10001'
ExtAPIUpdateInvalidEprRegistrationNumberException:
value:
message: The Germany product EPR registration number is already rejected or deleted, so not able to update.
code: '10007'
schema:
$ref: '#/components/schemas/APIError'
description: Failed to update a Germany product EPR registration number.
parameters:
- $ref: '#/components/parameters/de_epr_id'
tags:
- Germany EPR Compliance
summary: Update a Germany Product EPR Registration Number
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateGermanyProductEprRegistrationNumber'
security:
- OAuth2:
- compliance:write
operationId: updateGermanyProductEprRegistrationNumber
x-code-samples:
- lang: python_requests
source: "import requests\n\nurl = \"https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number/{id}\"\n\npayload = \"{\\\"epr_number\\\":\\\"string\\\",\\\"organization_or_representative_name\\\":\\\"string\\\"}\"\nheaders = {\n 'content-type': \"application/json\",\n 'authorization': \"Bearer REPLACE_BEARER_TOKEN\"\n }\n\nresponse = requests.request(\"PUT\", url, data=payload, headers=headers)\n\nprint(response.text)"
- lang: javascript_jquery
source: "var settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number/{id}\",\n \"method\": \"PUT\",\n \"headers\": {\n \"content-type\": \"application/json\",\n \"authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n },\n \"processData\": false,\n \"data\": \"{\\\"epr_number\\\":\\\"string\\\",\\\"organization_or_representative_name\\\":\\\"string\\\"}\"\n}\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});"
- lang: php_curl
source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n CURLOPT_URL => \"https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number/{id}\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"PUT\",\n CURLOPT_POSTFIELDS => \"{\\\"epr_number\\\":\\\"string\\\",\\\"organization_or_representative_name\\\":\\\"string\\\"}\",\n CURLOPT_HTTPHEADER => array(\n \"authorization: Bearer REPLACE_BEARER_TOKEN\",\n \"content-type: application/json\"\n ),\n));\n\n$response = curl_exec($curl);\n$err = curl_error($curl);\n\ncurl_close($curl);\n\nif ($err) {\n echo \"cURL Error #:\" . $err;\n} else {\n echo $response;\n}"
- lang: shell_curl
source: "curl --request PUT \\\n --url 'https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number/{id}' \\\n --header 'authorization: Bearer REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data '{\"epr_number\":\"string\",\"organization_or_representative_name\":\"string\"}'"
- lang: java_unirest
source: "HttpResponse<String> response = Unirest.put(\"https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number/{id}\")\n .header(\"content-type\", \"application/json\")\n .header(\"authorization\", \"Bearer REPLACE_BEARER_TOKEN\")\n .body(\"{\\\"epr_number\\\":\\\"string\\\",\\\"organization_or_representative_name\\\":\\\"string\\\"}\")\n .asString();"
description: Update details of a Germany Product EPR Registration Number.
get:
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/GermanyProductEprRegistrationNumberResponse'
description: Successfully queried for a Germany product EPR registration number.
'400':
content:
application/json:
examples:
ExtAPIEprRegistrationNumberNotFoundException:
value:
message: The input Germany product EPR registration number is not found by the given id.
code: '10003'
ExtAPIEprRegistrationNumberNoAccessException:
value:
message: The Germany product EPR registration number is not accessable for the operated merchant.
code: '10004'
schema:
$ref: '#/components/schemas/APIError'
description: Failed to query for a Germany product EPR registration number.
parameters:
- $ref: '#/components/parameters/de_epr_id'
tags:
- Germany EPR Compliance
summary: Get a Germany Product EPR Registration Number
security:
- OAuth2:
- compliance:read
operationId: getGermanyProductEprRegistrationNumber
x-code-samples:
- lang: python_requests
source: 'import requests
url = "https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number/{id}"
headers = {''authorization'': ''Bearer REPLACE_BEARER_TOKEN''}
response = requests.request("GET", url, headers=headers)
print(response.text)'
- lang: javascript_jquery
source: "var settings = {\n \"async\": true,\n \"crossDomain\": true,\n \"url\": \"https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number/{id}\",\n \"method\": \"GET\",\n \"headers\": {\n \"authorization\": \"Bearer REPLACE_BEARER_TOKEN\"\n }\n}\n\n$.ajax(settings).done(function (response) {\n console.log(response);\n});"
- lang: php_curl
source: "<?php\n\n$curl = curl_init();\n\ncurl_setopt_array($curl, array(\n CURLOPT_URL => \"https://merchant.wish.com/api/v3/germany_epr_compliance/epr_registration_number/{id}\",\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => \"\",\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 30,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => \"GET\",\n CURLOPT_HTTPHEADER => array(\n \"authorization: Bearer REPLACE_B
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/wish/refs/heads/main/openapi/wish-germany-epr-compliance-api-openapi.yml