POST
/
returns
curl --request POST \
  --url https://api.stateset.com/v1/returns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "action_needed": "<string>",
  "amount": "<string>",
  "condition": "<string>",
  "country": "<string>",
  "created_string": "<string>",
  "customer_email": "<string>",
  "customer_email_normalized": "<string>",
  "customer_id": "<string>",
  "description": "<string>",
  "enteredBy": "<string>",
  "fedex_status": "<string>",
  "flat_rate_shipping": 123,
  "id": "<string>",
  "issue": "<string>",
  "match": "<string>",
  "order_id": "<string>",
  "order_refunded": true,
  "order_string": "<string>",
  "reason_category": "<string>",
  "refunded_string": "<string>",
  "reported_condition": "<string>",
  "requested_string": "<string>",
  "rma": "<string>",
  "scanned_serial_number": "<string>",
  "serial_number": "<string>",
  "shipped_string": "<string>",
  "sso_id": "<string>",
  "status": "<string>",
  "tax_refunded": "<string>",
  "total_refunded": "<string>",
  "tracking_number": "<string>",
  "warehouse_condition_string": "<string>",
  "warehouse_received_string": "<string>",
  "workflow_id": "<string>",
  "zendesk_number": "<string>"
}'
This response has no body data.

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Body

action_needed
string

Any action required to process the return.

amount
string

The amount of the return.

condition
string

The condition of the returned item.

country
string

The country of the customer who initiated the return.

created_string
string
default: now()

The string the return was created.

customer_email
string

The email address of the customer who initiated the return.

customer_email_normalized
string

The normalized email address of the customer who initiated the return.

customer_id
string

The unique identifier of the customer who initiated the return.

description
string

A description of the return.

enteredBy
string

The name of the employee who entered the return into the system.

fedex_status
string

The status of the return in FedEx.

flat_rate_shipping
integer

The flat rate shipping amount.

id
string
issue
string

The reason for the return.

match
string

Whether or not the serial number matches the order.

order_id
string

The order ID associated with the return.

order_refunded
boolean
default: false

Whether or not the order was refunded.

order_string
string

The string the order was placed.

reason_category
string

The category of the reason for the return.

refunded_string
string

The string the return was refunded.

reported_condition
string

The condition of the returned item.

requested_string
string

The string the return was requested.

rma
string

The return merchandise authorization number.

scanned_serial_number
string

The serial number of the returned item.

serial_number
string

The serial number of the returned item.

shipped_string
string

The string the order was shipped.

sso_id
string

The unique identifier of the SSO user who initiated the return.

status
string

The status of the return.

tax_refunded
string

The amount of tax refunded.

total_refunded
string

The total amount refunded.

tracking_number
string

The tracking number of the returned item.

warehouse_condition_string
string

The string the condition of the return was verified at the warehouse.

warehouse_received_string
string

The string the return was received at the warehouse.

workflow_id
string

The workflow ID associated with the return.

zendesk_number
string

The unique identifier of the Zendesk ticket associated with the return.