Update Marketplace
Use this request to update a marketplace's entire set of settings.
As a matter of best practice, it is intended for you to use this request to pass a complete set of settings to the service. This means that if you omit any required data, it could be missing once you update the set.
To avoid this, you can use the Set Settings request to update settings individually.
If you do omit an existing setting, the system will usually not delete the omitted setting.
Settings that are changed are used from Midnight of the day the request was received. To set a setting at a specified time, you can use the Set Settings request.
To update a marketplace's settings, use a PUT method and the following URL:
{service_URI}/marketplace/v1/sellers
where {service_URI}
is the service's URL.
For example:
$ curl \
-H "x-marketplace-token: ms_{ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-X GET PUT \
--data '{JSON}' \
https://sellers-api.marketplace.taxamo.com/marketplace/v1/marketplaces
where:
{ACCESS_TOKEN}
is your access token used for authentication.{JSON}
is the body of the request where you specify the seller's details.
Details
API Component Type | API Component |
---|---|
Endpoint | /marketplace/v1/sellers |
Method | PUT |
API Reference Document | Update Marketplace |
Fields
Field | Description |
---|---|
marketplace_token | Specify the token used to authenticate the marketplace. |
marketplace_code | Specify the token used to identify the marketplace. This is mandatory. |
All the fields are listed in the Marketplace Settings Reference Guide topic. An overview of the settings is provided in the Marketplace Settings Overview topic.
Request
For example, you can specify the following updates to your marketplace's settings:
{
"settings": [
{
"value": {
"tax_number_validation": {
"validation_request_timeout_ms": 200,
"cache_expiry_timeout_days": 5
},
"taxation": {
"digital": {
"back_to_back_transaction_templates": {
"transaction": {
"newKey": "New Value"
}
},
"accept_all_countries_during_autodetection": true
},
"physical": {
"back_to_back_transaction_templates": {
"transaction": {
"newKey": "New Value"
}
}
},
"back_to_back_transaction_tax_country_code": "IE"
},
"invoicing": {
"detect_currency_from_tax_country": true,
"invoice_email_subject": "{{invoice_number}}",
"refund_note_email_subject": "{{refund_note_number}}",
"invoice_number_format": "{{year}}",
"generate_optional_invoices": true,
"is_invoice_delivery_enabled": true,
"invoice_email_from_address": "[email protected]",
"invoice_footer_text": "Thanks",
"invoice_logo_url": "https://www.example.com/images"
},
"countries": {
"UK": {
"is_domestic": false,
"country_subdivisions": {
"NI": {
"taxation": {
"is_enabled": false
}
}
}
}
},
"timezone": "Europe/Dublin"
},
"effective_from": "2022-01-01"
}
],
"postal_code": "IE",
"business_name": "Example Markets",
"email": "[email protected]",
"postal_address_line3": "Dublin",
"postal_address_line2": "Main Street",
"last_name": "Test",
"first_name": "Joanie",
"postal_address_line1": "Duff Towers",
"country": "IE",
"marketplace_code": "ABC1234"
}
'
Response
When the record is created successfully, a 200 code is returned.
Updated 4 months ago