Modify Merchant Order Config
Modifies the merchants order configuration based on a given merchant_id
.
Merchant Configuration is currently in beta.
Available Order Configurations
Custom Tags - custom_tags
This configuration allows you to provide a set of tags that will be included with any orders submitted for this merchant.
Path parameters
merchant_idinteger · int32Required
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Body
Configurations for the merchants order behaviors.
commerce_disabledbooleanOptionalDefault:
Is order creation, or cart submission, disabled for this merchant.
false
custom_tagsstring[]Optional
Custom tags to be added to a merchants orders upon submission.
prohibit_order_cancellationsbooleanOptionalDefault:
Does this merchants prohibit order cancellations.
false
prohibit_order_refundsbooleanOptionalDefault:
Does this merchants prohibit order refunds.
false
Responses
default
default response
application/json
put
PUT /v1/merchants/{merchant_id}/configuration/orders_config HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 31
{
"custom_tags": [
"tag1",
"tag2"
]
}
default
default response
{
"global_feature_flags": {
"sync_metadata": false,
"sync_collections": true
},
"platform_feature_flags": {
"filter_by_collections": false,
"use_custom_shipping_rates": true
},
"orders_config": {
"custom_tags": [
"tag1",
"tag2"
]
}
}
Last updated
Was this helpful?