Checkout configuration (1.0.1)

Download OpenAPI specification:Download

Use this API to configure and manage checkout process in the NewStore platform. This includes manager approvals, enabling automatic promotions, refunds, and other features in the platform.

For more information, see the configuration guide.

Checkout configuration

Get checkout configuration

Retrieves the current checkout configuration set up for your business. The response payload also contains the current version of the configuration, the timestamp when it was last updated, and who updated it.

Authorizations:

newStoreAccessToken

header Parameters

request_id	string
tenant required	string
user-id	string

Responses

Response samples

200
404
500

Content type

application/json

{"value": {"enable_manager_approval": true,
"gift_wrapping": {"message_enabled": true,
"price": 0,
"tax_code": "string"
},
"i18n": {"default_customer_locale": "string"
},
"big_sales_order": {"hard_limit_for_big_orders": 0
},
"refund_payment_methods": ["string"
],
"refund_payment_methods_for_blind_return": ["string"
]
},
"version": "string",
"updated_at": "2021-12-31T23:59:59Z",
"updated_by": "string"
}

Update checkout configuration

Updates the current checkout configuration for your business.

Authorizations:

newStoreAccessToken

query Parameters

version

required

string

header Parameters

request_id	string
tenant required	string
user-id	string

Request Body schema: application/json

The updated config value

enable_manager_approval	boolean Defines if the manager approval feature is enabled or not.
	object
	object Internationalization configuration for checkout.
	object Determines how many items an in-store order is limited to.
refund_payment_methods	Array of strings
refund_payment_methods_for_blind_return	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"enable_manager_approval": true,
"gift_wrapping": {"message_enabled": true,
"price": 0,
"tax_code": "string"
},
"i18n": {"default_customer_locale": "string"
},
"big_sales_order": {"hard_limit_for_big_orders": 0
},
"refund_payment_methods": ["string"
],
"refund_payment_methods_for_blind_return": ["string"
]
}

Response samples

200
400
404
409
500

Content type

application/json

{"value": {"enable_manager_approval": true,
"gift_wrapping": {"message_enabled": true,
"price": 0,
"tax_code": "string"
},
"i18n": {"default_customer_locale": "string"
},
"big_sales_order": {"hard_limit_for_big_orders": 0
},
"refund_payment_methods": ["string"
],
"refund_payment_methods_for_blind_return": ["string"
]
},
"version": "string",
"updated_at": "2021-12-31T23:59:59Z",
"updated_by": "string"
}

Replace checkout configuration

Use this method to create a new checkout configuration and completely replace the current configuration for your business.

Authorizations:

newStoreAccessToken

query Parameters

version

required

string

header Parameters

request_id	string
tenant required	string
user-id	string

Request Body schema: application/json

The updated config value

enable_manager_approval	boolean Defines if the manager approval feature is enabled or not.
	object
	object Internationalization configuration for checkout.
	object Determines how many items an in-store order is limited to.
refund_payment_methods	Array of strings
refund_payment_methods_for_blind_return	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"enable_manager_approval": true,
"gift_wrapping": {"message_enabled": true,
"price": 0,
"tax_code": "string"
},
"i18n": {"default_customer_locale": "string"
},
"big_sales_order": {"hard_limit_for_big_orders": 0
},
"refund_payment_methods": ["string"
],
"refund_payment_methods_for_blind_return": ["string"
]
}

Response samples

200
400
404
409
500

Content type

application/json

{"value": {"enable_manager_approval": true,
"gift_wrapping": {"message_enabled": true,
"price": 0,
"tax_code": "string"
},
"i18n": {"default_customer_locale": "string"
},
"big_sales_order": {"hard_limit_for_big_orders": 0
},
"refund_payment_methods": ["string"
],
"refund_payment_methods_for_blind_return": ["string"
]
},
"version": "string",
"updated_at": "2021-12-31T23:59:59Z",
"updated_by": "string"
}