ReturnLogic API (V1)

Download OpenAPI specification:Download

Getting Started

Authentication

The ReturnLogic API uses bearer tokens to authenticate requests. You must pass the token in the Authorization HTTP request header.

Authorization: Bearer {{your token here}}

Error Codes

Any API call could return an error:

  • 401 - Unauthorized
  • 400 - Bad Request
  • 429 - Rate Limit Exceeded
  • 503 - Down For Maintenance

Rate Limiting

The default rate limit for a ReturnLogic API key is 2 requests per second and 120 requests per minute. If an API request exceeds the rate limit, the API will return a 429 Rate Limit Exceeded response. The following HTTP headers will be present on all API responses to help you stay within the limit.

  • X-RateLimit-Limit-Second: maximum number of calls client can make in 1 second
  • X-RateLimit-Limit-Minute: maximum number of calls client can make in 1 minute
  • X-RateLimit-Remaining-Second: remaining number of calls client can make in 1 second
  • X-RateLimit-Remaining-Minute: remaining number of calls client can make in 1 minute

Order

List Orders

Get a list of Orders

query Parameters
skip
integer <int32> >= 0
Default: 0

Number of items to skip over

limit
integer <int32> [ 1 .. 250 ]
Default: 20

Limit on number of items to return

orderNumber
string

Find Orders by order number

orderName
string

Find Orders by order name

email
string

Find Orders by email address. Case insensitive, exact match only.

minCreateDate
string <date-time>

Find Orders created on or after this date

maxCreateDate
string <date-time>

Find Orders created on or before this date

financialStatus
string (OrderFinancialStatus)
Enum: "authorized" "paid" "partially_paid" "pending" "refunded" "voided" "ThirdParty"

Find Orders by their financial status

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Order

Create a new order

Request Body schema: application/json
externalOrderId
required
string

The ID of the order on the ecommerce platform (i.e. Shopify)

externalCustomerId
number <double>

The ID of the customer who placed the order on the ecommerce platform (i.e. Shopify)

customerEmail
string

The email provided when creating this order.

customerPhone
string

The customer phone provided when creating this order.

orderNumber
required
string

Order number provided to the customer to identify the order. Used to initiate RMAs.

orderName
required
string

Order name provided to the customer to identify the order. Can be used to initiate RMAs.

object (Address)
object (Address)
fulfillmentStatus
string (OrderFulfillmentStatus)
Enum: "fulfilled" "partial" "restocked"
financialStatus
string (OrderFinancialStatus)
Enum: "authorized" "paid" "partially_paid" "pending" "refunded" "voided" "ThirdParty"
externalSource
string

Name of ecommerce platform where order was originally created

sourceType
string

How the order was collected, i.e. web, pos, in-store

shippedAt
string <date-time>

Date the order was shipped.

tags
required
Array of strings

A list of tags on the order.

taxesIncluded
required
boolean

Are taxes included in the price of the order items.

shopCurrencyCode
required
string <= 3 characters

3 letter code of the currency used by the store. // TODO currency code ISO standard?

totalPrice
required
number <double>

Amount billed to customer after applying discounts, taxes, shipping, and other fees

fees
required
number <double>

Additional fees added to order not reported on order items

taxPrice
required
number <double>

Amount of tax applied to order

shippingPrice
required
number <double>

Cost of shipping

refundAmount
required
number <double>

Total value refunded to order

externalCreateDate
string <date-time>

Date order was created on ecommerce platform

externalUpdateDate
string <date-time>

Date order was updated on ecommerce platform

gateway
string

Payment gateway used to process the order

Array of AddProductToOrderRequest (object) or AddCustomItemToOrderRequest (object) (AddOrderItemToOrderRequest)

Array of order items to create

Array of objects (OrderDiscountAttributes)

Array of order discounts to create

Responses

Request samples

Content type
application/json
{
  • "externalOrderId": "string",
  • "externalCustomerId": 0,
  • "customerEmail": "string",
  • "customerPhone": "string",
  • "orderNumber": "string",
  • "orderName": "string",
  • "shippingAddress": {