Skip to main content
API docs by Redocly

Item Return Configuration API (1.0)

Download OpenAPI specification:Download

Use this API to configure how returns work in the NewStore platform. This includes:

  • Configuring the return window, which indicates the number of days within which the item can be returned from the date of purchase.
  • Configuring the return fee, which indicates the amount the customer has to pay to return an item in the order.
  • Configuring if shipping cost should be refunded when all the products in the order are returned.

For more information, see the configuration guide.

Get item return configuration

Retrieves the current configuration of returns set up in the NewStore platform. The response payload also includes metadata such as who updated the configuration and when.

For more information, see the parent resource.

Authorizations:
newStoreAccessToken

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "updated_by": "user@example.com",
  • "updated_at": "2021-11-04T10:11:44Z"
}

Update item return configuration

Updates the current configuration set up for returning items in your business.

Authorizations:
newStoreAccessToken
Request Body schema: application/json

The updated config value

return_window
number >= 0

Number of days after the purchase when it is possible to return the products.

return_fee
number >= 0

Monetary amount the customer pays to return a product. Assumes the currency of the order that is returned.

refund_shipping_cost
boolean

Set this parameter to true to refund the shipping cost after all the products of the order are returned.

return_with_lla_support
boolean

Set this parameter to true to enable the Line Level Appeasement for In-Store returns (default: false).

Responses

Request samples

Content type
application/json
{
  • "return_window": 90
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "updated_by": "user@retailer.com",
  • "updated_at": "2021-11-04T10:11:44Z"
}

Create or replace item return configuration

Use this method to create a new configuration, or replace the current configuration, for returning items in your business. For more information, see the parent resource.

Authorizations:
newStoreAccessToken
Request Body schema: application/json

The updated config value

return_window
number >= 0

Number of days after the purchase when it is possible to return the products.

return_fee
number >= 0

Monetary amount the customer pays to return a product. Assumes the currency of the order that is returned.

refund_shipping_cost
boolean

Set this parameter to true to refund the shipping cost after all the products of the order are returned.

return_with_lla_support
boolean

Set this parameter to true to enable the Line Level Appeasement for In-Store returns (default: false).

Responses

Request samples

Content type
application/json
{
  • "return_window": 90,
  • "return_fee": 0,
  • "refund_shipping_cost": false
}

Response samples

Content type
application/json
{
  • "value": {
    },
  • "updated_by": "user@retailer.com",
  • "updated_at": "2021-11-04T10:11:44Z"
}