Create Return Policy

1 min

POST

https://api.upstartcommerce.com/v1/return-policy

This endpoint allows operators to create a new return policy.

Header Parameters

x-upstart-tenantstringrequired
Description
Tenant identifier associated with the site this call is for.
x-upstart-sitestring
Description
Unique identifier for the site.

Body Parameters

bodyCreateReturnPolicyrequired
- idstring<uuid>
  Description
  Unique identifier for the return policy. If it is not provided a random one will be generated.
  Format
  uuid
- siteIdsSiteId[]required
- namestringrequired
  Description
  A human-readable name of the return policy.
- activationDatestring<date-time>
  Example
  2021-12-01T00:00:00Z
  Description
  An optional date determining since when the return policy is activated. If it is not provided, the activation has no lower bound.
  Format
  date-time
- archivedboolean
  Description
  Determines whether the return policy is archived or not.
  Default
  false
- deactivationDatestring<date-time>
  Example
  2021-12-21T00:30:00Z
  Description
  An optional date determining until when the return policy is activated. If it is not provided, the activation has no upper bound.
  Format
  date-time
- groupsReturnPolicyGroup[]required
  - namestringrequired
    Description
    A human-readable name of this return policy group (e.g. King Size Mattress).
  - triggerGroupReturnPolicySubject[]required
    Description
    A subject that might take place as a trigger or qualifier for a return policy. It can be a
    
    particular SKU or the whole product.
    - ReturnPolicyProduct
      - typestringrequired
      - idstringrequired
        Description
        A product ID of the product.
    - ReturnPolicySku
      - typestringrequired
      - idstringrequired
        Description
        A product ID of the product this SKU belongs to.
      - skuIdstringrequired
        Description
        An ID of this SKU.
  - qualifyingGroupReturnPolicySubject[]required
    Description
    A subject that might take place as a trigger or qualifier for a return policy. It can be a
    
    particular SKU or the whole product.
    - ReturnPolicyProduct
      - typestringrequired
      - idstringrequired
        Description
        A product ID of the product.
    - ReturnPolicySku
      - typestringrequired
      - idstringrequired
        Description
        A product ID of the product this SKU belongs to.
      - skuIdstringrequired
        Description
        An ID of this SKU.
- triggeredTemplatestringrequired
  Description
  A message template to be populated once this return policy is triggered by cart content.
- unqualifiedTemplatestringrequired
  Description
  A message template to be populated when this return policy is triggered by cart content but the cart content does not qualify for the return policy.

Responses

201

Success-return policy created.

ReturnPolicy
- idstring<uuid>required
  Description
  Unique identifier for the return policy. If it is not provided a random one will be generated.
  Format
  uuid
- siteIdsSiteId[]required
- namestringrequired
  Description
  A human-readable name of the return policy.
- groupsReturnPolicyGroup[]required
  - namestringrequired
    Description
    A human-readable name of this return policy group (e.g. King Size Mattress).
  - triggerGroupReturnPolicySubject[]required
    Description
    A subject that might take place as a trigger or qualifier for a return policy. It can be a
    
    particular SKU or the whole product.
    - ReturnPolicyProduct
      - typestringrequired
      - idstringrequired
        Description
        A product ID of the product.
    - ReturnPolicySku
      - typestringrequired
      - idstringrequired
        Description
        A product ID of the product this SKU belongs to.
      - skuIdstringrequired
        Description
        An ID of this SKU.
  - qualifyingGroupReturnPolicySubject[]required
    Description
    A subject that might take place as a trigger or qualifier for a return policy. It can be a
    
    particular SKU or the whole product.
    - ReturnPolicyProduct
      - typestringrequired
      - idstringrequired
        Description
        A product ID of the product.
    - ReturnPolicySku
      - typestringrequired
      - idstringrequired
        Description
        A product ID of the product this SKU belongs to.
      - skuIdstringrequired
        Description
        An ID of this SKU.
- unqualifiedTemplatestringrequired
  Description
  A message template to be populated when this return policy is triggered by cart content but the cart content does not qualify for the return policy.
- triggeredTemplatestringrequired
  Description
  A message template to be populated once this return policy is triggered by cart content.
- activationDatestring<date-time>
  Example
  2021-12-01T00:00:00Z
  Description
  An optional date determining since when the return policy is activated. If it is not provided, the activation has no lower bound.
  Format
  date-time
- deactivationDatestring<date-time>
  Example
  2021-12-21T00:30:00Z
  Description
  An optional date determining until when the return policy is activated. If it is not provided, the activation has no upper bound.
  Format
  date-time
- archivedboolean
  Description
  Determines whether the return policy is archived or not.
  Default
  false

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

ValidationErrorResponse
- namestringrequired
- codestringrequired
- detailstring

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

ErrorResponse
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring

curl

curl --request POST \
     --url https://api.upstartcommerce.com/v1/return-policy \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '{
     "siteIds": [],
     "name": "",
     "groups": [
     {
     "name": "",
     "triggerGroup": {
     "type": "",
     "id": ""
     },
     "qualifyingGroup": {
     "type": "",
     "id": ""
     }
     }
     ],
     "triggeredTemplate": "",
     "unqualifiedTemplate": ""
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");

var raw = JSON.stringify({
   "siteIds": [],
   "name": "",
   "groups": [
      {
         "name": "",
         "triggerGroup": {
            "type": "",
            "id": ""
         },
         "qualifyingGroup": {
            "type": "",
            "id": ""
         }
      }
   ],
   "triggeredTemplate": "",
   "unqualifiedTemplate": ""
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.upstartcommerce.com/v1/return-policy", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.upstartcommerce.com/v1/return-policy")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"
request.body = JSON.dump({
   "siteIds": [],
   "name": "",
   "groups": [
      {
         "name": "",
         "triggerGroup": {
            "type": "",
            "id": ""
         },
         "qualifyingGroup": {
            "type": "",
            "id": ""
         }
      }
   ],
   "triggeredTemplate": "",
   "unqualifiedTemplate": ""
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.upstartcommerce.com/v1/return-policy"

payload = json.dumps({
   "siteIds": [],
   "name": "",
   "groups": [
      {
         "name": "",
         "triggerGroup": {
            "type": "",
            "id": ""
         },
         "qualifyingGroup": {
            "type": "",
            "id": ""
         }
      }
   ],
   "triggeredTemplate": "",
   "unqualifiedTemplate": ""
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-upstart-tenant': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

201

// Success-return policy created.
{
  "id": "",
  "siteIds": [
    ""
  ],
  "name": "",
  "groups": [
    {
      "name": "",
      "triggerGroup": {},
      "qualifyingGroup": {}
    }
  ],
  "unqualifiedTemplate": "",
  "triggeredTemplate": "",
  "activationDate": "2021-12-01T00:00:00Z",
  "deactivationDate": "2021-12-21T00:30:00Z",
  "archived": false
}

400

// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.
{
  "name": "",
  "code": "",
  "detail": ""
}

401

// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}