StateSet API Docs

curl --location --request GET 'https://api.stateset.com/v1/return/retrieve' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "id": "rt_1NXWPnCo6bFb1KQto6C8OWvE",
}'

query ($limit: Int!, $offset: Int!, $order_direction: order_by) {
  returns(limit: $limit, offset: $offset, order_by: {created_date: $order_direction}) {
    id
    created_date
    amount
    action_needed
    condition
    customerEmail
    customer_id
    description
    enteredBy
    flat_rate_shipping
    order_date
    order_id
    reason_category
    reported_condition
    requested_date
    rma
    serial_number
    shipped_date
    status
    tax_refunded
    total_refunded
    tracking_number
    return_line_items {
      amount
      condition
      flat_rate_shipping
      id
      name
      price
      return_id
      serial_number
      sku
      tax_refunded
    }
  }
}

const returns = await stateset.returns.retrieve({
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
});

returns = stateset.returns.retrieve({
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
})

returns, err := stateset.Returns.Retrieve(
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
)

returns = Stateset::Returns.retrieve(
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
)

Returns returns = Stateset.Returns.retrieve(
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
);

Returns returns = Stateset.Returns.Retrieve(
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
);

$returns = Stateset\Returns::retrieve(
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
);

GET /v1/return HTTP/1.1
Host: api.stateset.com
Content-Type: application/json

{
    "returns": [
        {
            "id": "rt_1NXWPnCo6bFb1KQto6C8OWvE",
            "created_date": "2023-06-28T19:34:59.189838+00:00",
            "amount": null,
            "action_needed": null,
            "condition": null,
            "customerEmail": "customer@gmail.com",
            "customer_id": null,
            "description": null,
            "enteredBy": null,
            "flat_rate_shipping": null,
            "order_date": null,
            "order_id": "524213310335630636",
            "reason_category": null,
            "reported_condition": null,
            "requested_date": null,
            "rma": "#1014-R5",
            "serial_number": null,
            "shipped_date": null,
            "status": "RCV",
            "tax_refunded": null,
            "total_refunded": null,
            "tracking_number": null,
            "return_line_items": []
        },
    ]
}

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Return not found",
    "details": {
      "resource": "return",
      "id": "ret_abc123"
    },
    "request_id": "req_abc123def456"
  }
}

{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The API key provided is invalid or has been revoked",
    "request_id": "req_abc123def456"
  }
}

GET

return

:id

retrieve

curl --location --request GET 'https://api.stateset.com/v1/return/retrieve' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "id": "rt_1NXWPnCo6bFb1KQto6C8OWvE",
}'

query ($limit: Int!, $offset: Int!, $order_direction: order_by) {
  returns(limit: $limit, offset: $offset, order_by: {created_date: $order_direction}) {
    id
    created_date
    amount
    action_needed
    condition
    customerEmail
    customer_id
    description
    enteredBy
    flat_rate_shipping
    order_date
    order_id
    reason_category
    reported_condition
    requested_date
    rma
    serial_number
    shipped_date
    status
    tax_refunded
    total_refunded
    tracking_number
    return_line_items {
      amount
      condition
      flat_rate_shipping
      id
      name
      price
      return_id
      serial_number
      sku
      tax_refunded
    }
  }
}

const returns = await stateset.returns.retrieve({
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
});

returns = stateset.returns.retrieve({
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
})

returns, err := stateset.Returns.Retrieve(
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
)

returns = Stateset::Returns.retrieve(
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
)

Returns returns = Stateset.Returns.retrieve(
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
);

Returns returns = Stateset.Returns.Retrieve(
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
);

$returns = Stateset\Returns::retrieve(
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
);

GET /v1/return HTTP/1.1
Host: api.stateset.com
Content-Type: application/json

{
    "returns": [
        {
            "id": "rt_1NXWPnCo6bFb1KQto6C8OWvE",
            "created_date": "2023-06-28T19:34:59.189838+00:00",
            "amount": null,
            "action_needed": null,
            "condition": null,
            "customerEmail": "customer@gmail.com",
            "customer_id": null,
            "description": null,
            "enteredBy": null,
            "flat_rate_shipping": null,
            "order_date": null,
            "order_id": "524213310335630636",
            "reason_category": null,
            "reported_condition": null,
            "requested_date": null,
            "rma": "#1014-R5",
            "serial_number": null,
            "shipped_date": null,
            "status": "RCV",
            "tax_refunded": null,
            "total_refunded": null,
            "tracking_number": null,
            "return_line_items": []
        },
    ]
}

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Return not found",
    "details": {
      "resource": "return",
      "id": "ret_abc123"
    },
    "request_id": "req_abc123def456"
  }
}

{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The API key provided is invalid or has been revoked",
    "request_id": "req_abc123def456"
  }
}

Body

string

This is the id of the return.

Response

string

This is the id of the return.

created_date

string

This is the date the return was created.

amount

string

This is the amount of the return.

action_needed

string

This is the action needed for the return.

condition

string

This is the condition of the return.

customerEmail

string

This is the email of the customer.

customer_id

string

This is the id of the customer.

description

string

This is the description of the return.

enteredBy

string

This is the id of the user who entered the return.

flat_rate_shipping

string

This is the flat rate shipping of the return.

order_date

string

This is the date of the order.

order_id

string

This is the id of the order.

reason_category

string

This is the reason category of the return.

reported_condition

string

This is the reported condition of the return.

requested_date

string

This is the requested date of the return.

rma

string

This is the rma of the return.

serial_number

string

This is the serial number of the return.

shipped_date

string

This is the shipped date of the return.

status

string

This is the status of the return.

tax_refunded

string

This is the tax refunded of the return.

total_refunded

string

This is the total refunded of the return.

tracking_number

string

This is the tracking number of the return.

return_line_items

object

This is the line items of the return.

Show Show child attributes

string

This is the id of the return line item.

amount

string

This is the amount of the return line item.

condition

string

This is the condition of the return line item.

flat_rate_shipping

string

This is the flat rate shipping of the return line item.

name

string

This is the name of the return line item.

price

string

This is the price of the return line item.

return_id

string

This is the id of the return associated with the line item.

serial_number

string

This is the serial number of the return line item.

sku

string

This is the sku of the return line item.

tax_refunded

string

This is the tax refunded of the return line item.

curl --location --request GET 'https://api.stateset.com/v1/return/retrieve' \
--header 'Content-Type: application/json' \
--header 'Authorization: Token <token>' \
--data-raw '{
    "id": "rt_1NXWPnCo6bFb1KQto6C8OWvE",
}'

query ($limit: Int!, $offset: Int!, $order_direction: order_by) {
  returns(limit: $limit, offset: $offset, order_by: {created_date: $order_direction}) {
    id
    created_date
    amount
    action_needed
    condition
    customerEmail
    customer_id
    description
    enteredBy
    flat_rate_shipping
    order_date
    order_id
    reason_category
    reported_condition
    requested_date
    rma
    serial_number
    shipped_date
    status
    tax_refunded
    total_refunded
    tracking_number
    return_line_items {
      amount
      condition
      flat_rate_shipping
      id
      name
      price
      return_id
      serial_number
      sku
      tax_refunded
    }
  }
}

const returns = await stateset.returns.retrieve({
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
});

returns = stateset.returns.retrieve({
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
})

returns, err := stateset.Returns.Retrieve(
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
)

returns = Stateset::Returns.retrieve(
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
)

Returns returns = Stateset.Returns.retrieve(
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
);

Returns returns = Stateset.Returns.Retrieve(
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
);

$returns = Stateset\Returns::retrieve(
  'rt_1NXWPnCo6bFb1KQto6C8OWvE'
);

GET /v1/return HTTP/1.1
Host: api.stateset.com
Content-Type: application/json

{
    "returns": [
        {
            "id": "rt_1NXWPnCo6bFb1KQto6C8OWvE",
            "created_date": "2023-06-28T19:34:59.189838+00:00",
            "amount": null,
            "action_needed": null,
            "condition": null,
            "customerEmail": "customer@gmail.com",
            "customer_id": null,
            "description": null,
            "enteredBy": null,
            "flat_rate_shipping": null,
            "order_date": null,
            "order_id": "524213310335630636",
            "reason_category": null,
            "reported_condition": null,
            "requested_date": null,
            "rma": "#1014-R5",
            "serial_number": null,
            "shipped_date": null,
            "status": "RCV",
            "tax_refunded": null,
            "total_refunded": null,
            "tracking_number": null,
            "return_line_items": []
        },
    ]
}

{
  "error": {
    "code": "RESOURCE_NOT_FOUND",
    "message": "Return not found",
    "details": {
      "resource": "return",
      "id": "ret_abc123"
    },
    "request_id": "req_abc123def456"
  }
}

{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The API key provided is invalid or has been revoked",
    "request_id": "req_abc123def456"
  }
}

List Returns Create Return

​Body

​Response

Body

Response