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}}
Your public app must have a redirect url that is set up to accept the following query string parameters:
code
- The authorization code generated after a successful installationteamId
- The unique identifier of the retailer that installed your appWhenever a retailer installs your app, we will redirect the retailer to your URL with the auth code and the teamId appended in the query string.
https://www.your-public-app.com/app/authorize_redirect?code=a22bcde12345&teamId=36bd1371-1eac-40d3-92f4-065982ff9d3f
Use the code provided and make an HTTP POST request to https://api.returnlogic.com/v1/oauth with the following body:
{
"grant_type": "authorization_code",
"client_id": "YOUR_CLIENT_ID",
"client_secret": "YOUR_CLIENT_SECRET",
"code": "a22bcde12345"
}
You'll receive a Bearer token and a Refresh token:
{
"bearer_token": "uebjkefgh84372",
"refresh_token": "buelfxkdezxc10392"
}
The bearer token can be used to make API requests. The refresh token can be used to generate new bearer tokens when they expire.
It is your responsibility to keep track of bearer tokens for each retailer that installs your application.
Webhooks allow a developer to register with our systems requesting to be notified when specific actions or events occur in the ReturnLogic environment. When a developer has subscribed to an action our system will notify the developer's application at the endpoint they defined providing a payload of data about the event. This payload allows their application to be aware of the actions, such as a new RMA being created, updated, or deleted. This sequence enables a developer to have their application respond to an event in our platform in near real-time if their endpoint is reachable.
Things to keep in mind about webhooks.
Order is not guaranteed
- The order webhooks are delivered is not guaranteed. They will be delivered based on queue and retry attempts.
Delivery is not guaranteed
- While our system will make every attempt to deliver a webhook message, we can not guarantee delivery or receipt of a delivery.
Developers should never assume that all notifications will make it to their endpoint 100% of the time.
Delivery failures are typically caused by our system's inability to contact the registered endpoint.
Generally, this is due to an invalid endpoint URI definition or an internet connectivity problem between the two systems.
How messages are delivered
-
While the exact time to delivery will depend on several factors, such as the connection between our servers and the endpoint the developer registers, delivery is sent in the following manner.
deactivate the registration.
When this happens,
no messages will be sent to that endpoint until the developer updates the registration setting it back to a active status.
Any messages that would have sent to the endpoint while it is in a deactivated status will not be delivered.
Only messages generated after the endpoint is updated back to an active status will be queued and delivered by the webhook system.
Running a list webhooks API call will provide a status of which registrations are active or inactive.
Editing the affected endpoint registration and setting the active parameter value to true will reset the error count and once again enable the registration.Any API call could return an error:
401
- Unauthorized400
- Bad Request429
- Rate Limit Exceeded503
- Down For MaintenanceThe 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 secondX-RateLimit-Limit-Minute
: maximum number of calls client can make in 1 minuteX-RateLimit-Remaining-Second
: remaining number of calls client can make in 1 secondX-RateLimit-Remaining-Minute
: remaining number of calls client can make in 1 minuteRetrieve a list of customers or find a specific customer using their email or external customer ID
limit | integer <int32> [ 1 .. 250 ] Default: 20 The number of customers to return |
skip | integer <int32> >= 0 Default: 0 The number of customers to skip |
string The email address of the customer | |
externalCustomerId | string The external customer ID |
[- {
- "rlCustomerId": 0,
- "teamId": "string",
- "email": "string",
- "externalCustomerId": "string",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "externalCreateDate": "2019-08-24T14:15:22Z",
- "externalUpdateDate": "2019-08-24T14:15:22Z"
}
]
Find a specific customer using their RL Customer ID
rlCustomerId required | number <double> The RL Customer ID |
{- "rlCustomerId": 0,
- "teamId": "string",
- "email": "string",
- "externalCustomerId": "string",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "externalCreateDate": "2019-08-24T14:15:22Z",
- "externalUpdateDate": "2019-08-24T14:15:22Z"
}
Update customer details by modifying an existing customer record, such as changing their email or tags
rlCustomerId required | number <double> The RL Customer ID |
Any fields on the Customer model that need to be updated
string The email address of the customer | |
externalCustomerId | string The ID of the customer on the ecommerce platform (i.e. Shopify) |
tags | Array of strings An array of tags (attributes) that are associated with the customer |
createdAt | string <date-time> The date and time that the customer was created in ReturnLogic |
updatedAt | string <date-time> The date and time that the customer was last updated in ReturnLogic |
externalCreateDate | string <date-time> The date and time that the customer was created on the ecommerce platform |
externalUpdateDate | string <date-time> The date and time that the customer was last updated on the ecommerce platform |
{- "email": "string",
- "externalCustomerId": "string",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "externalCreateDate": "2019-08-24T14:15:22Z",
- "externalUpdateDate": "2019-08-24T14:15:22Z"
}
{- "rlCustomerId": 0,
- "teamId": "string",
- "email": "string",
- "externalCustomerId": "string",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "externalCreateDate": "2019-08-24T14:15:22Z",
- "externalUpdateDate": "2019-08-24T14:15:22Z"
}
Delete a customer from the database, permanently removing their information using their RL Customer ID
rlCustomerId required | number <double> The RL Customer ID |
{- "status": 400,
- "message": "",
- "name": "ValidateError",
- "fields": {
- "integrationTypeId": {
- "message": "invalid number",
- "value": "this is not a number"
}
}
}
Create a new customer by submitting their details
email required | string The email address of the customer |
externalCustomerId required | string The ID of the customer on the ecommerce platform (i.e. Shopify) |
tags required | Array of strings An array of tags (attributes) that are associated with the customer |
createdAt required | string <date-time> The date and time that the customer was created in ReturnLogic |
updatedAt required | string <date-time> The date and time that the customer was last updated in ReturnLogic |
externalCreateDate required | string <date-time> The date and time that the customer was created on the ecommerce platform |
externalUpdateDate required | string <date-time> The date and time that the customer was last updated on the ecommerce platform |
{- "email": "string",
- "externalCustomerId": "string",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "externalCreateDate": "2019-08-24T14:15:22Z",
- "externalUpdateDate": "2019-08-24T14:15:22Z"
}
{- "rlCustomerId": 0,
- "teamId": "string",
- "email": "string",
- "externalCustomerId": "string",
- "tags": [
- "string"
], - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "externalCreateDate": "2019-08-24T14:15:22Z",
- "externalUpdateDate": "2019-08-24T14:15:22Z"
}
Get a list of Orders
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 |
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 |
[- {
- "rlOrderId": 87654,
- "externalOrderId": "1456032",
- "externalSource": "Shopify",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "externalCreateDate": "2024-10-06T17:56:38.921Z",
- "externalUpdateDate": "2024-10-08T17:56:38.921Z",
- "billingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "shippingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "customerEmail": "admin@returnlogic.com",
- "customerPhone": "111-111-1111",
- "orderName": "RL1234",
- "orderNumber": "1234",
- "gateway": "Paypal",
- "flatRateBonusCreditApplied": false,
- "subtotalPrice": 30.5,
- "totalPrice": 40,
- "shippingPrice": 5.95,
- "fees": 0,
- "orderLevelDiscount": 0,
- "taxPrice": 3.55,
- "taxesIncluded": false,
- "refundAmount": 0,
- "shippedAt": "2024-10-07T17:56:38.921Z",
- "shopCurrencyCode": "USD",
- "tags": [ ],
- "fulfillmentStatus": "fulfilled",
- "isPseudo": false,
- "discounts": [
- {
- "rlOrderDiscountId": 60294,
- "rlOrderId": 87654,
- "externalOrderId": "1456032",
- "amount": 5,
- "code": "SUMMERFUN",
- "isShippingDiscount": false
}
], - "orderItems": [
- {
- "rlOrderItemId": 913743,
- "rlOrderId": 87654,
- "externalOrderItemId": "3049177",
- "externalProductId": "4922",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "sku": "10015204",
- "displayName": "Keyboard",
- "productExists": true,
- "quantity": 2,
- "pricePerItem": 18,
- "discountPerItem": 2.75,
- "actualPricePerItem": 15.25,
- "taxPerItem": 1.52,
- "totalPrice": 36,
- "totalDiscount": 5.5,
- "totalTax": 3.04,
- "isTaxable": true,
- "fulfillableQuantity": 0,
- "fulfillmentStatus": "fulfilled",
- "isGiftCard": false,
- "properties": [ ],
- "refundQuantity": 0,
- "grams": 2000,
- "discounts": [ ]
}
]
}
]
Create a new order
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. |
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. If the gateway's value is 'manual', any rmas created for this order will be flagged for manual payment processing. |
flatRateBonusCreditApplied | boolean A flat rate bonus credit was applied to a return request; this value ensures that a flat rate bonus credit can only be applied once per 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 |
{- "externalOrderId": "string",
- "externalCustomerId": 0,
- "customerEmail": "string",
- "customerPhone": "string",
- "orderNumber": "string",
- "orderName": "string",
- "shippingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "billingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "fulfillmentStatus": "fulfilled",
- "financialStatus": "authorized",
- "externalSource": "string",
- "sourceType": "string",
- "shippedAt": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
], - "taxesIncluded": true,
- "shopCurrencyCode": "str",
- "totalPrice": 0,
- "fees": 0,
- "taxPrice": 0,
- "shippingPrice": 0,
- "refundAmount": 0,
- "externalCreateDate": "2019-08-24T14:15:22Z",
- "externalUpdateDate": "2019-08-24T14:15:22Z",
- "gateway": "string",
- "flatRateBonusCreditApplied": true,
- "orderItems": [
- {
- "externalOrderItemId": "string",
- "quantity": 0,
- "isTaxable": true,
- "isGiftCard": true,
- "taxPerItem": 0,
- "vendor": "string",
- "fulfillmentService": "string",
- "fulfillmentStatus": "fulfilled",
- "fulfillableQuantity": 0,
- "properties": [
- "string"
], - "refundQuantity": 0,
- "orderItemDiscounts": [
- {
- "amount": 0,
- "code": "string",
- "isShippingDiscount": true
}
], - "rlProductVariantId": 0,
- "priceOverride": 0
}
], - "orderDiscounts": [
- {
- "amount": 0,
- "code": "string",
- "isShippingDiscount": true
}
]
}
{- "rlOrderId": 87654,
- "externalOrderId": "1456032",
- "externalSource": "Shopify",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "externalCreateDate": "2024-10-06T17:56:38.921Z",
- "externalUpdateDate": "2024-10-08T17:56:38.921Z",
- "billingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "shippingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "customerEmail": "admin@returnlogic.com",
- "customerPhone": "111-111-1111",
- "orderName": "RL1234",
- "orderNumber": "1234",
- "gateway": "Paypal",
- "flatRateBonusCreditApplied": false,
- "subtotalPrice": 30.5,
- "totalPrice": 40,
- "shippingPrice": 5.95,
- "fees": 0,
- "orderLevelDiscount": 0,
- "taxPrice": 3.55,
- "taxesIncluded": false,
- "refundAmount": 0,
- "shippedAt": "2024-10-07T17:56:38.921Z",
- "shopCurrencyCode": "USD",
- "tags": [ ],
- "fulfillmentStatus": "fulfilled",
- "isPseudo": false,
- "discounts": [
- {
- "rlOrderDiscountId": 60294,
- "rlOrderId": 87654,
- "externalOrderId": "1456032",
- "amount": 5,
- "code": "SUMMERFUN",
- "isShippingDiscount": false
}
], - "orderItems": [
- {
- "rlOrderItemId": 913743,
- "rlOrderId": 87654,
- "externalOrderItemId": "3049177",
- "externalProductId": "4922",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "sku": "10015204",
- "displayName": "Keyboard",
- "productExists": true,
- "quantity": 2,
- "pricePerItem": 18,
- "discountPerItem": 2.75,
- "actualPricePerItem": 15.25,
- "taxPerItem": 1.52,
- "totalPrice": 36,
- "totalDiscount": 5.5,
- "totalTax": 3.04,
- "isTaxable": true,
- "fulfillableQuantity": 0,
- "fulfillmentStatus": "fulfilled",
- "isGiftCard": false,
- "properties": [ ],
- "refundQuantity": 0,
- "grams": 2000,
- "discounts": [ ]
}
]
}
Count total number of Orders
orderNumber | string Find Orders by their order number |
orderName | string Find Orders by their order name |
string Find Orders associated with an email address | |
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 |
{- "count": 0
}
{- "rlOrderId": 87654,
- "externalOrderId": "1456032",
- "externalSource": "Shopify",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "externalCreateDate": "2024-10-06T17:56:38.921Z",
- "externalUpdateDate": "2024-10-08T17:56:38.921Z",
- "billingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "shippingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "customerEmail": "admin@returnlogic.com",
- "customerPhone": "111-111-1111",
- "orderName": "RL1234",
- "orderNumber": "1234",
- "gateway": "Paypal",
- "flatRateBonusCreditApplied": false,
- "subtotalPrice": 30.5,
- "totalPrice": 40,
- "shippingPrice": 5.95,
- "fees": 0,
- "orderLevelDiscount": 0,
- "taxPrice": 3.55,
- "taxesIncluded": false,
- "refundAmount": 0,
- "shippedAt": "2024-10-07T17:56:38.921Z",
- "shopCurrencyCode": "USD",
- "tags": [ ],
- "fulfillmentStatus": "fulfilled",
- "isPseudo": false,
- "discounts": [
- {
- "rlOrderDiscountId": 60294,
- "rlOrderId": 87654,
- "externalOrderId": "1456032",
- "amount": 5,
- "code": "SUMMERFUN",
- "isShippingDiscount": false
}
], - "orderItems": [
- {
- "rlOrderItemId": 913743,
- "rlOrderId": 87654,
- "externalOrderItemId": "3049177",
- "externalProductId": "4922",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "sku": "10015204",
- "displayName": "Keyboard",
- "productExists": true,
- "quantity": 2,
- "pricePerItem": 18,
- "discountPerItem": 2.75,
- "actualPricePerItem": 15.25,
- "taxPerItem": 1.52,
- "totalPrice": 36,
- "totalDiscount": 5.5,
- "totalTax": 3.04,
- "isTaxable": true,
- "fulfillableQuantity": 0,
- "fulfillmentStatus": "fulfilled",
- "isGiftCard": false,
- "properties": [ ],
- "refundQuantity": 0,
- "grams": 2000,
- "discounts": [ ]
}
]
}
Update an existing order. Cannot change monetary values after an RMA has been created.
rlOrderId required | integer <int32> Order ID |
customerEmail | string The email provided when creating this order. |
customerPhone | string or null The customer phone provided when creating this order. |
object (Address) | |
object (Address) | |
fulfillmentStatus | string or null Enum: "fulfilled" "partial" "restocked" Order fulfillment status |
financialStatus | string (OrderFinancialStatus) Enum: "authorized" "paid" "partially_paid" "pending" "refunded" "voided" "ThirdParty" |
sourceType | string How the order was collected, i.e. web, pos, in-store |
shippedAt | string or null <date-time> Date the order was shipped. |
tags | Array of strings A list of tags on the order. |
taxesIncluded | boolean Are taxes included in the price of the order items. |
shopCurrencyCode | string <= 3 characters 3 letter code of the currency used by the store. |
totalPrice | number <double> Amount billed to customer after applying discounts, taxes, shipping, and other fees |
fees | number <double> Additional fees added to order not reported on order items |
taxPrice | number <double> Amount of tax applied to order |
shippingPrice | number <double> Cost of shipping |
refundAmount | number <double> Total value refunded to order |
externalUpdateDate | string <date-time> Date order was updated on ecommerce platform |
gateway | string or null Payment gateway used to process the order |
{- "customerEmail": "string",
- "customerPhone": "string",
- "shippingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "billingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "fulfillmentStatus": "fulfilled",
- "financialStatus": "authorized",
- "sourceType": "string",
- "shippedAt": "2019-08-24T14:15:22Z",
- "tags": [
- "string"
], - "taxesIncluded": true,
- "shopCurrencyCode": "str",
- "totalPrice": 0,
- "fees": 0,
- "taxPrice": 0,
- "shippingPrice": 0,
- "refundAmount": 0,
- "externalUpdateDate": "2019-08-24T14:15:22Z",
- "gateway": "string"
}
{- "rlOrderId": 87654,
- "externalOrderId": "1456032",
- "externalSource": "Shopify",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "externalCreateDate": "2024-10-06T17:56:38.921Z",
- "externalUpdateDate": "2024-10-08T17:56:38.921Z",
- "billingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "shippingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "customerEmail": "admin@returnlogic.com",
- "customerPhone": "111-111-1111",
- "orderName": "RL1234",
- "orderNumber": "1234",
- "gateway": "Paypal",
- "flatRateBonusCreditApplied": false,
- "subtotalPrice": 30.5,
- "totalPrice": 40,
- "shippingPrice": 5.95,
- "fees": 0,
- "orderLevelDiscount": 0,
- "taxPrice": 3.55,
- "taxesIncluded": false,
- "refundAmount": 0,
- "shippedAt": "2024-10-07T17:56:38.921Z",
- "shopCurrencyCode": "USD",
- "tags": [ ],
- "fulfillmentStatus": "fulfilled",
- "isPseudo": false,
- "discounts": [
- {
- "rlOrderDiscountId": 60294,
- "rlOrderId": 87654,
- "externalOrderId": "1456032",
- "amount": 5,
- "code": "SUMMERFUN",
- "isShippingDiscount": false
}
], - "orderItems": [
- {
- "rlOrderItemId": 913743,
- "rlOrderId": 87654,
- "externalOrderItemId": "3049177",
- "externalProductId": "4922",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "sku": "10015204",
- "displayName": "Keyboard",
- "productExists": true,
- "quantity": 2,
- "pricePerItem": 18,
- "discountPerItem": 2.75,
- "actualPricePerItem": 15.25,
- "taxPerItem": 1.52,
- "totalPrice": 36,
- "totalDiscount": 5.5,
- "totalTax": 3.04,
- "isTaxable": true,
- "fulfillableQuantity": 0,
- "fulfillmentStatus": "fulfilled",
- "isGiftCard": false,
- "properties": [ ],
- "refundQuantity": 0,
- "grams": 2000,
- "discounts": [ ]
}
]
}
Add an order item to an existing order
rlOrderId required | integer <int32> Order ID |
externalOrderItemId required | string The ID of the order item on the ecommerce platform |
quantity required | integer <int32> The quantity of product on this order item |
isTaxable required | boolean Is this order item taxable |
isGiftCard required | boolean Is this order item a gift card |
taxPerItem required | number <double> Tax per item |
vendor | string Order item vendor |
fulfillmentService | string Order item fulfillment service |
fulfillmentStatus | string (OrderFulfillmentStatus) Enum: "fulfilled" "partial" "restocked" |
fulfillableQuantity | number <double> Quantity on order line that have not yet been fulfilled |
properties | Array of strings List of properties assigned to the order line |
refundQuantity | number <double> Quantity on order line that have been refunded |
Array of objects (OrderDiscountAttributes) Discounts applied to order item | |
rlProductVariantId required | number <double> Product variant ID on ReturnLogic of variant associated with order item |
priceOverride | number <double> Price to use instead of the catalog price |
{- "externalOrderItemId": "string",
- "quantity": 0,
- "isTaxable": true,
- "isGiftCard": true,
- "taxPerItem": 0,
- "vendor": "string",
- "fulfillmentService": "string",
- "fulfillmentStatus": "fulfilled",
- "fulfillableQuantity": 0,
- "properties": [
- "string"
], - "refundQuantity": 0,
- "orderItemDiscounts": [
- {
- "amount": 0,
- "code": "string",
- "isShippingDiscount": true
}
], - "rlProductVariantId": 0,
- "priceOverride": 0
}
{- "rlOrderId": 87654,
- "externalOrderId": "1456032",
- "externalSource": "Shopify",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "externalCreateDate": "2024-10-06T17:56:38.921Z",
- "externalUpdateDate": "2024-10-08T17:56:38.921Z",
- "billingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "shippingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "customerEmail": "admin@returnlogic.com",
- "customerPhone": "111-111-1111",
- "orderName": "RL1234",
- "orderNumber": "1234",
- "gateway": "Paypal",
- "flatRateBonusCreditApplied": false,
- "subtotalPrice": 30.5,
- "totalPrice": 40,
- "shippingPrice": 5.95,
- "fees": 0,
- "orderLevelDiscount": 0,
- "taxPrice": 3.55,
- "taxesIncluded": false,
- "refundAmount": 0,
- "shippedAt": "2024-10-07T17:56:38.921Z",
- "shopCurrencyCode": "USD",
- "tags": [ ],
- "fulfillmentStatus": "fulfilled",
- "isPseudo": false,
- "discounts": [
- {
- "rlOrderDiscountId": 60294,
- "rlOrderId": 87654,
- "externalOrderId": "1456032",
- "amount": 5,
- "code": "SUMMERFUN",
- "isShippingDiscount": false
}
], - "orderItems": [
- {
- "rlOrderItemId": 913743,
- "rlOrderId": 87654,
- "externalOrderItemId": "3049177",
- "externalProductId": "4922",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "sku": "10015204",
- "displayName": "Keyboard",
- "productExists": true,
- "quantity": 2,
- "pricePerItem": 18,
- "discountPerItem": 2.75,
- "actualPricePerItem": 15.25,
- "taxPerItem": 1.52,
- "totalPrice": 36,
- "totalDiscount": 5.5,
- "totalTax": 3.04,
- "isTaxable": true,
- "fulfillableQuantity": 0,
- "fulfillmentStatus": "fulfilled",
- "isGiftCard": false,
- "properties": [ ],
- "refundQuantity": 0,
- "grams": 2000,
- "discounts": [ ]
}
]
}
Update an existing order item. Cannot change monetary values after an RMA has been created.
rlOrderId required | integer <int32> Order ID |
rlOrderItemId required | number <double> Order Item ID |
EditOrderItemRequest
quantity | integer <int32> The quantity of product on this order item |
isTaxable | boolean Is this order item taxable |
isGiftCard | boolean Is this order item a gift card |
taxPerItem | number <double> Tax per item |
vendor | string Order item vendor |
fulfillmentService | string Order item fulfillment service |
fulfillmentStatus | string (OrderFulfillmentStatus) Enum: "fulfilled" "partial" "restocked" |
fulfillableQuantity | number <double> Quantity on order line that have not yet been fulfilled |
properties | Array of strings List of properties assigned to the order line |
refundQuantity | number <double> Quantity on order line that have been refunded |
{- "quantity": 0,
- "isTaxable": true,
- "isGiftCard": true,
- "taxPerItem": 0,
- "vendor": "string",
- "fulfillmentService": "string",
- "fulfillmentStatus": "fulfilled",
- "fulfillableQuantity": 0,
- "properties": [
- "string"
], - "refundQuantity": 0
}
{- "rlOrderId": 87654,
- "externalOrderId": "1456032",
- "externalSource": "Shopify",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "externalCreateDate": "2024-10-06T17:56:38.921Z",
- "externalUpdateDate": "2024-10-08T17:56:38.921Z",
- "billingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "shippingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "customerEmail": "admin@returnlogic.com",
- "customerPhone": "111-111-1111",
- "orderName": "RL1234",
- "orderNumber": "1234",
- "gateway": "Paypal",
- "flatRateBonusCreditApplied": false,
- "subtotalPrice": 30.5,
- "totalPrice": 40,
- "shippingPrice": 5.95,
- "fees": 0,
- "orderLevelDiscount": 0,
- "taxPrice": 3.55,
- "taxesIncluded": false,
- "refundAmount": 0,
- "shippedAt": "2024-10-07T17:56:38.921Z",
- "shopCurrencyCode": "USD",
- "tags": [ ],
- "fulfillmentStatus": "fulfilled",
- "isPseudo": false,
- "discounts": [
- {
- "rlOrderDiscountId": 60294,
- "rlOrderId": 87654,
- "externalOrderId": "1456032",
- "amount": 5,
- "code": "SUMMERFUN",
- "isShippingDiscount": false
}
], - "orderItems": [
- {
- "rlOrderItemId": 913743,
- "rlOrderId": 87654,
- "externalOrderItemId": "3049177",
- "externalProductId": "4922",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "sku": "10015204",
- "displayName": "Keyboard",
- "productExists": true,
- "quantity": 2,
- "pricePerItem": 18,
- "discountPerItem": 2.75,
- "actualPricePerItem": 15.25,
- "taxPerItem": 1.52,
- "totalPrice": 36,
- "totalDiscount": 5.5,
- "totalTax": 3.04,
- "isTaxable": true,
- "fulfillableQuantity": 0,
- "fulfillmentStatus": "fulfilled",
- "isGiftCard": false,
- "properties": [ ],
- "refundQuantity": 0,
- "grams": 2000,
- "discounts": [ ]
}
]
}
Removes an order item from an order. Cannot delete an order item that is part of an RMA.
rlOrderId required | integer <int32> Order ID |
rlOrderItemId required | integer <int32> Order Item ID |
{- "rlOrderId": 87654,
- "externalOrderId": "1456032",
- "externalSource": "Shopify",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "externalCreateDate": "2024-10-06T17:56:38.921Z",
- "externalUpdateDate": "2024-10-08T17:56:38.921Z",
- "billingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "shippingAddress": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "customerEmail": "admin@returnlogic.com",
- "customerPhone": "111-111-1111",
- "orderName": "RL1234",
- "orderNumber": "1234",
- "gateway": "Paypal",
- "flatRateBonusCreditApplied": false,
- "subtotalPrice": 30.5,
- "totalPrice": 40,
- "shippingPrice": 5.95,
- "fees": 0,
- "orderLevelDiscount": 0,
- "taxPrice": 3.55,
- "taxesIncluded": false,
- "refundAmount": 0,
- "shippedAt": "2024-10-07T17:56:38.921Z",
- "shopCurrencyCode": "USD",
- "tags": [ ],
- "fulfillmentStatus": "fulfilled",
- "isPseudo": false,
- "discounts": [
- {
- "rlOrderDiscountId": 60294,
- "rlOrderId": 87654,
- "externalOrderId": "1456032",
- "amount": 5,
- "code": "SUMMERFUN",
- "isShippingDiscount": false
}
], - "orderItems": [
- {
- "rlOrderItemId": 913743,
- "rlOrderId": 87654,
- "externalOrderItemId": "3049177",
- "externalProductId": "4922",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "sku": "10015204",
- "displayName": "Keyboard",
- "productExists": true,
- "quantity": 2,
- "pricePerItem": 18,
- "discountPerItem": 2.75,
- "actualPricePerItem": 15.25,
- "taxPerItem": 1.52,
- "totalPrice": 36,
- "totalDiscount": 5.5,
- "totalTax": 3.04,
- "isTaxable": true,
- "fulfillableQuantity": 0,
- "fulfillmentStatus": "fulfilled",
- "isGiftCard": false,
- "properties": [ ],
- "refundQuantity": 0,
- "grams": 2000,
- "discounts": [ ]
}
]
}
Add a single product to a category
rlProductCategoryId required | integer <int32> RL Product Category ID |
rlProductId required | integer <int32> RL Product ID |
{- "name": "string",
- "externalCategoryId": "string",
- "imageUrl": "string",
- "imageAlt": "string",
- "rlProductCategoryId": 0,
- "rlProducts": [
- {
- "rlProductCategoryId": 0,
- "rlProductId": 0
}
]
}
Removes a single product from a category
rlProductCategoryId required | integer <int32> RL Product Category ID |
rlProductId required | integer <int32> RL Product ID |
{- "name": "string",
- "externalCategoryId": "string",
- "imageUrl": "string",
- "imageAlt": "string",
- "rlProductCategoryId": 0,
- "rlProducts": [
- {
- "rlProductCategoryId": 0,
- "rlProductId": 0
}
]
}
Count total number of Products For Category
categoryId required | integer <int32> Find only Products in category |
sku | string Find only Products with variants matching sku |
status | string (ProductStatus) Enum: "active" "inActive" "any" Find only Products active/inActive/any |
{- "count": 0
}
Get the list of Products inside a category
categoryId required | integer <int32> Find only Products in category |
sku | string Find only Products with variants matching sku |
status | string (ProductStatus) Enum: "active" "inActive" "any" Find only Products active/inActive/any |
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 |
curl api.returnlogic.com/v1/productCategories/{categoryId}/products\ -H "Authorization: Bearer {{your_api_token}}"\
[- {
- "isActive": true,
- "rlProductId": 534122,
- "name": "Licensed Metal Bike",
- "vendor": "Returnlogic",
- "tags": [
- "tag1",
- "tag2"
], - "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "variants": [
- {
- "externalVariantId": "12345",
- "imageUrl": "",
- "inventoryQuantity": 55,
- "isActive": true,
- "name": "Tuna",
- "position": 1,
- "rlProductId": 534122,
- "rlProductVariantId": 876876,
- "sku": "Mouse",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "variantCreatedAt": "2024-10-06T17:56:38.921Z",
- "variantUpdatedAt": "2024-10-08T17:56:38.921Z",
- "grams": 2,
- "weight": 2,
- "weightUnit": "g",
- "isDeleted": false,
- "isPublic": true
}
], - "isDeleted": false,
- "isPublic": true
}
]
Get a single product category by ID
rlProductCategoryId required | integer <int32> Product Category ID |
{- "name": "string",
- "externalCategoryId": "string",
- "imageUrl": "string",
- "imageAlt": "string",
- "rlProductCategoryId": 0,
- "rlProducts": [
- {
- "rlProductCategoryId": 0,
- "rlProductId": 0
}
]
}
Partially update an existing a product category.
rlProductCategoryId required | integer <int32> ReturnLogic Product Category ID |
Product Category Properties to Update
name | string Product Category Name |
imageUrl | string Full URL to Product Category Image |
imageAlt | string Alt text for Product Category Image |
{- "name": "string",
- "imageUrl": "string",
- "imageAlt": "string"
}
{- "name": "string",
- "externalCategoryId": "string",
- "imageUrl": "string",
- "imageAlt": "string",
- "rlProductCategoryId": 0,
- "rlProducts": [
- {
- "rlProductCategoryId": 0,
- "rlProductId": 0
}
]
}
Get the list of Products Categories
name | string to search product category by |
externalCategoryIds | Array of strings Find categories matching a list of ids from an external source |
skip | integer <int32> >= 0 Default: 0 Number of items to skip over |
limit | integer <int32> [ 1 .. 250 ] Default: 10 Limit on number of items to return |
rlProductId | number <double> Only list product categories to which the rlProductId belongs. If using this parameter, only the specified product will be included in the product array. |
[- {
- "name": "string",
- "externalCategoryId": "string",
- "imageUrl": "string",
- "imageAlt": "string",
- "rlProductCategoryId": 0,
- "rlProducts": [
- {
- "rlProductCategoryId": 0,
- "rlProductId": 0
}
]
}
]
Creates a product category containing products.
Product Category Creation Attributes
name required | string Product Category Name |
externalCategoryId required | string External ID of category from eCommerce platform |
imageUrl | string Full URL of category image to display to users |
imageAlt | string Image alt text |
Array of objects (CreateProductCategoryItem) Optional ReturnLogic Product IDs to add upon creation of category |
{- "name": "string",
- "externalCategoryId": "string",
- "imageUrl": "string",
- "imageAlt": "string",
- "rlProducts": [
- {
- "rlProductId": 0
}
]
}
{- "name": "string",
- "externalCategoryId": "string",
- "imageUrl": "string",
- "imageAlt": "string",
- "rlProductCategoryId": 0,
- "rlProducts": [
- {
- "rlProductCategoryId": 0,
- "rlProductId": 0
}
]
}
Update Product
rlProductId required | integer <int32> ReturnLogic Product ID |
Attributes to update on RL Product
isActive | boolean Setting this to false will 'soft delete' the product, effectively removing it from ReturnLogic. If it was purchased, it will still show up in existing orders. |
externalProductId | string The ID of the product in the ecommerce platform |
name | string Product name |
inventoryQuantity | integer <int32> Total product inventory |
price | number <double> Product price |
vendor | string Vendor, such as original manufacturer, wholesaler, etc. |
productType | string Product Type |
tags | Array of strings Tags |
imageUrl | string Full URL to product image |
Array of objects (UpdateProductOption) ReturnLogic Product Options |
{- "isActive": true,
- "externalProductId": "string",
- "name": "string",
- "inventoryQuantity": 0,
- "price": 0,
- "vendor": "string",
- "productType": "string",
- "tags": [
- "string"
], - "imageUrl": "string",
- "options": [
- {
- "externalOptionId": "string",
- "name": "string",
- "position": 0,
- "rlProductOptionId": 0
}
]
}
{- "isActive": true,
- "rlProductId": 534122,
- "name": "Licensed Metal Bike",
- "vendor": "Returnlogic",
- "tags": [
- "tag1",
- "tag2"
], - "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "variants": [
- {
- "externalVariantId": "12345",
- "imageUrl": "",
- "inventoryQuantity": 55,
- "isActive": true,
- "name": "Tuna",
- "position": 1,
- "rlProductId": 534122,
- "rlProductVariantId": 876876,
- "sku": "Mouse",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "variantCreatedAt": "2024-10-06T17:56:38.921Z",
- "variantUpdatedAt": "2024-10-08T17:56:38.921Z",
- "grams": 2,
- "weight": 2,
- "weightUnit": "g",
- "isDeleted": false,
- "isPublic": true
}
], - "isDeleted": false,
- "isPublic": true
}
Get Single Product
rlProductId required | integer <int32> Product identifier |
curl api.returnlogic.com/v1/products/{rlProductId}\ -H "Authorization: Bearer {{your_api_token}}"\
{- "isActive": true,
- "rlProductId": 534122,
- "name": "Licensed Metal Bike",
- "vendor": "Returnlogic",
- "tags": [
- "tag1",
- "tag2"
], - "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "variants": [
- {
- "externalVariantId": "12345",
- "imageUrl": "",
- "inventoryQuantity": 55,
- "isActive": true,
- "name": "Tuna",
- "position": 1,
- "rlProductId": 534122,
- "rlProductVariantId": 876876,
- "sku": "Mouse",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "variantCreatedAt": "2024-10-06T17:56:38.921Z",
- "variantUpdatedAt": "2024-10-08T17:56:38.921Z",
- "grams": 2,
- "weight": 2,
- "weightUnit": "g",
- "isDeleted": false,
- "isPublic": true
}
], - "isDeleted": false,
- "isPublic": true
}
Get the list of Products
sku | string Find only Products with variants matching sku |
categoryId | integer <int32> Find only Products in category |
status | string (ProductStatus) Enum: "active" "inActive" "any" Find only Products active/inActive/any |
externalProductIds | Array of strings Find products matching a list of ids from an external source |
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 |
curl api.returnlogic.com/v1/products\ -H "Authorization: Bearer {{your_api_token}}"\
[- {
- "isActive": true,
- "rlProductId": 534122,
- "name": "Licensed Metal Bike",
- "vendor": "Returnlogic",
- "tags": [
- "tag1",
- "tag2"
], - "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "variants": [
- {
- "externalVariantId": "12345",
- "imageUrl": "",
- "inventoryQuantity": 55,
- "isActive": true,
- "name": "Tuna",
- "position": 1,
- "rlProductId": 534122,
- "rlProductVariantId": 876876,
- "sku": "Mouse",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "variantCreatedAt": "2024-10-06T17:56:38.921Z",
- "variantUpdatedAt": "2024-10-08T17:56:38.921Z",
- "grams": 2,
- "weight": 2,
- "weightUnit": "g",
- "isDeleted": false,
- "isPublic": true
}
], - "isDeleted": false,
- "isPublic": true
}
]
Creates a product within ReturnLogic
isActive required | boolean Setting this to false will 'soft delete' the product, effectively removing it from ReturnLogic. If it was purchased, it will still show up in existing orders. |
externalProductId required | string External ID from ecommerce system |
name | string Product name |
vendor required | string Vendor, such as original manufacturer, wholesaler, etc. |
productType | string Product Type |
tags | Array of strings Tags |
imageUrl | string Full URL to product image |
productCreatedAt | string <date-time> (IsoDate) ISO-8601 Date time |
productUpdateAt | string <date-time> (IsoDate) ISO-8601 Date time |
Array of objects (CreateProductWithOption) Product Options (Size, Material, Color) | |
required | Array of objects (CreateRlVariantReq) non-empty Product Variants. Products without options must have one variant. |
{- "isActive": true,
- "externalProductId": "string",
- "name": "string",
- "vendor": "string",
- "productType": "string",
- "tags": [
- "string"
], - "imageUrl": "string",
- "productCreatedAt": "YYYY-MM-DDThh:mm:ss",
- "productUpdateAt": "YYYY-MM-DDThh:mm:ss",
- "options": [
- {
- "externalOptionId": "string",
- "name": "string",
- "position": 0
}
], - "variants": [
- {
- "isActive": true,
- "externalVariantId": "string",
- "position": 0,
- "sku": "string",
- "name": "string",
- "price": 0,
- "grams": 0,
- "weight": 0,
- "weightUnit": "lb",
- "barcode": "string",
- "fulfillmentService": "string",
- "inventoryQuantity": 0,
- "inventoryItemId": 0,
- "imageUrl": "string",
- "variantCreatedAt": "YYYY-MM-DDThh:mm:ss",
- "variantUpdatedAt": "YYYY-MM-DDThh:mm:ss",
- "options": [
- {
- "externalOptionId": "string",
- "value": "string",
- "position": 0
}
]
}
]
}
{- "isActive": true,
- "rlProductId": 534122,
- "name": "Licensed Metal Bike",
- "vendor": "Returnlogic",
- "tags": [
- "tag1",
- "tag2"
], - "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "variants": [
- {
- "externalVariantId": "12345",
- "imageUrl": "",
- "inventoryQuantity": 55,
- "isActive": true,
- "name": "Tuna",
- "position": 1,
- "rlProductId": 534122,
- "rlProductVariantId": 876876,
- "sku": "Mouse",
- "createDate": "2024-10-06T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "variantCreatedAt": "2024-10-06T17:56:38.921Z",
- "variantUpdatedAt": "2024-10-08T17:56:38.921Z",
- "grams": 2,
- "weight": 2,
- "weightUnit": "g",
- "isDeleted": false,
- "isPublic": true
}
], - "isDeleted": false,
- "isPublic": true
}
Count total number of Products
sku | string Find only Products with variants matching sku |
categoryId | integer <int32> Find only Products in category |
status | string (ProductStatus) Enum: "active" "inActive" "any" Find only Products active/inActive/any |
curl api.returnlogic.com/v1/products/count\ -H "Authorization: Bearer {{your_api_token}}"\
{- "count": 0
}
Partial update for a product variant
rlProductId required | integer <int32> ReturnLogic Product ID |
rlProductVariantId required | integer <int32> ReturnLogic Variant ID |
Attributes to update on RL Variant
isActive | boolean Whether the product can be searched for and selected by customers for a return. |
externalVariantId | string External Variant ID from ecommerce platform |
position | integer <int32> Variant display position. Useful for sorting. |
sku | string SKU of specific product variant. |
name | string Name of variant |
price | number <double> Price of variant |
grams | integer <int32> Weight in grams |
weight | number <double> Original weight entered. |
weightUnit | string (MassUnit) Enum: "lb" "g" "kg" "oz" |
barcode | string Base64 Barcode value to be used |
fulfillmentService | string Name of service used to fulfill orders containing this variant. |
inventoryQuantity | integer <int32> Total product inventory |
inventoryItemId | integer <int32> External ID used for inventory purposes such as restocking. |
imageUrl | string Full URL to image of product variant |
variantUpdatedAt | string <date-time> (IsoDate) ISO-8601 Date time |
Array of objects (VariantOptionAttributes) Variant Options |
{- "isActive": true,
- "externalVariantId": "string",
- "position": 0,
- "sku": "string",
- "name": "string",
- "price": 0,
- "grams": 0,
- "weight": 0,
- "weightUnit": "lb",
- "barcode": "string",
- "fulfillmentService": "string",
- "inventoryQuantity": 0,
- "inventoryItemId": 0,
- "imageUrl": "string",
- "variantUpdatedAt": "YYYY-MM-DDThh:mm:ss",
- "options": [
- {
- "externalOptionId": "string",
- "value": "string",
- "position": 0
}
]
}
{- "isActive": true,
- "externalVariantId": "string",
- "position": 0,
- "sku": "string",
- "name": "string",
- "price": 0,
- "grams": 0,
- "weight": 0,
- "weightUnit": "lb",
- "barcode": "string",
- "fulfillmentService": "string",
- "inventoryQuantity": 0,
- "inventoryItemId": 0,
- "imageUrl": "string",
- "variantCreatedAt": "YYYY-MM-DDThh:mm:ss",
- "variantUpdatedAt": "YYYY-MM-DDThh:mm:ss",
- "createDate": "YYYY-MM-DDThh:mm:ss",
- "updateDate": "YYYY-MM-DDThh:mm:ss",
- "rlProductVariantId": 0,
- "rlProductId": 0,
- "options": [
- {
- "externalOptionId": "string",
- "value": "string",
- "position": 0,
- "rlProductVariantOptionId": 0,
- "rlProductVariantId": 0,
- "name": "string"
}
]
}
Add new variant to product. Variant Option values are required for products with options.
rlProductId required | integer <int32> ReturnLogic Product ID |
Creation attributes for Product Variant
isActive required | boolean Whether the product can be searched for and selected by customers for a return. |
externalVariantId required | string External Variant ID from ecommerce platform |
position required | integer <int32> Variant display position. Useful for sorting. |
sku required | string Sku The variant's sku. |
name required | string Name. The name of the variant, the name is required. |
price | number <double> Price of variant |
grams | integer <int32> Weight in grams |
weight required | number <double> Weight of item before packing. Any of the allowed MassUnits can be specified using the weightUnit field. |
weightUnit required | string (MassUnit) Enum: "lb" "g" "kg" "oz" |
barcode | string Base64 Barcode value to be used |
fulfillmentService | string Name of service used to fulfill orders containing this variant. |
inventoryQuantity required | integer <int32> Total product inventory |
inventoryItemId | integer <int32> External ID used for inventory purposes such as restocking. |
imageUrl | string Full URL to image of product variant |
variantCreatedAt | string <date-time> (IsoDate) ISO-8601 Date time |
variantUpdatedAt | string <date-time> (IsoDate) ISO-8601 Date time |
Array of objects (CreateVariantWithOption) Variant Option Values If the product is being created with options, you must specify variant option values for every option. |
{- "isActive": true,
- "externalVariantId": "string",
- "position": 0,
- "sku": "string",
- "name": "string",
- "price": 0,
- "grams": 0,
- "weight": 0,
- "weightUnit": "lb",
- "barcode": "string",
- "fulfillmentService": "string",
- "inventoryQuantity": 0,
- "inventoryItemId": 0,
- "imageUrl": "string",
- "variantCreatedAt": "YYYY-MM-DDThh:mm:ss",
- "variantUpdatedAt": "YYYY-MM-DDThh:mm:ss",
- "options": [
- {
- "externalOptionId": "string",
- "value": "string",
- "position": 0
}
]
}
{- "isActive": true,
- "externalVariantId": "string",
- "position": 0,
- "sku": "string",
- "name": "string",
- "price": 0,
- "grams": 0,
- "weight": 0,
- "weightUnit": "lb",
- "barcode": "string",
- "fulfillmentService": "string",
- "inventoryQuantity": 0,
- "inventoryItemId": 0,
- "imageUrl": "string",
- "variantCreatedAt": "YYYY-MM-DDThh:mm:ss",
- "variantUpdatedAt": "YYYY-MM-DDThh:mm:ss",
- "createDate": "YYYY-MM-DDThh:mm:ss",
- "updateDate": "YYYY-MM-DDThh:mm:ss",
- "rlProductVariantId": 0,
- "rlProductId": 0,
- "options": [
- {
- "externalOptionId": "string",
- "value": "string",
- "position": 0,
- "rlProductVariantOptionId": 0,
- "rlProductVariantId": 0,
- "name": "string"
}
]
}
Get a list of RMAs
Datetime format is ISO-8601 as defined in RFC 3339
Query Params that accept multiple strings should be formatted as comma-separated values
minCreateDate | string <date-time> (IsoDate) Example: minCreateDate=YYYY-MM-DDThh:mm:ss Find RMAs created on or after this date |
maxCreateDate | string <date-time> (IsoDate) Example: maxCreateDate=YYYY-MM-DDThh:mm:ss Find RMAs created on or before this date |
workflowStatus | Array of strings (RmaWorkflowStatusKey) Items Enum: "Abandoned" "Requested" "Authorized" "Canceled" "InTransit" "Delivered" "Active" "Received" "Processed" "Complete" "Rejected" Example: workflowStatus=Requested,Authorized Find only RMAs with workflowStatus in list |
returnType | Array of strings (RmaReturnType) Items Enum: "exchange" "warranty" "refund" "giftcard" Example: returnType=exchange,warranty Find only RMAs with returnType in list |
returnReasonCode | Array of strings Example: returnReasonCode=SZ,QTY Find only RMAs with return reason in list |
Array of strings Find RMAs by the rma email or order email. Case insensitive, exact match. | |
orderName | string Find only RMAs with orderName |
externalOrderNumber | string Find RMAs by their associated external order number |
showArchived | boolean Find only archived or non-archived RMAs |
thirdPartyOnly | boolean Find only third party RMAs |
requiresAction | boolean Find RMAs that aren't currently scheduled for automatic processing. If omitted, shows all RMAs. |
onlyFlaggedRmas | boolean Find only RMAs that have been flagged |
onlyWarrantyOutOfStock | boolean Find only RMAs that are flagged with a status code of Contact Customer Support |
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 |
curl api.returnlogic.com/v1/rmas\ -H "Authorization: Bearer {{your_api_token}}"\
[- {
- "teamId": "fe9588ff-c78f-4aa3-a247-7163bcd88ddc",
- "rlRmaId": 12345,
- "rlOrderId": 87654,
- "externalOrderNumber": "12345678",
- "orderName": "RL12345678",
- "rmaEmail": "admin@returnlogic.com",
- "orderEmail": "admin@returnlogic.com",
- "orderUrl": "",
- "fromShipping": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "toShipping": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US",
- "warehouseNickname": "NorthEast-3PL"
}, - "workflowStatus": "Delivered",
- "workflowStatusId": 5,
- "rowpointer": "ec145d2c-322f-48ad-8851-6eaff9187f30",
- "orderDate": "2024-08-25T17:56:38.921Z",
- "rmaExpirationDate": "2024-11-08T17:56:38.921Z",
- "isThirdParty": false,
- "receiptImageUrl": "",
- "isArchived": false,
- "isAllProcessed": false,
- "timeline": {
- "createDate": "2024-10-02T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "inTransitUpdateDate": "2024-10-05T17:56:38.921Z",
- "deliveredUpdateDate": "2024-10-07T17:56:38.921Z",
- "createdBy": {
- "email": "shopper@shopper.com",
- "userId": "3aab23a7-a472-4fe7-b64c-b5e8e5df1dc8"
}, - "authorizedBy": {
- "email": "admin@returnlogic.com",
- "userId": "3b57f944-5d35-4167-a2b1-2a70c9c61b57"
}, - "authorizedDate": "2024-10-02T17:56:38.921Z"
}, - "rmaItems": [
- {
- "rlRmaItemId": 1108598,
- "createDate": "2024-10-09T17:56:38.921Z",
- "updateDate": "2024-10-09T17:56:38.921Z",
- "rlRmaId": 23219291,
- "externalOrderLineId": "6170390691937",
- "orderId": "2907254030433",
- "quantity": 1,
- "acceptedQuantity": 1,
- "rmaItemApproved": true,
- "returnReasonCode": "OTH",
- "productVariantBarcode": "123456789",
- "sku": "KITTEHCAR01",
- "returnReasonDescription": "Too Small",
- "returnType": "refund",
- "rmaItemReceived": false,
- "disposition": {
- "code": "RFS",
- "comment": "In good condition",
- "restockProcessed": false,
- "restockQuantity": 1
}, - "rlProductId": 12345,
- "rlProductVariantId": 67890,
- "name": "Kitteh Car",
- "variantName": "small/red"
}
], - "shippingLabel": {
- "cost": 7.25,
- "trackingNumber": "9461200897846059728722",
- "carrier": "USPS",
- "shippingMethod": "ParcelSelect"
}, - "totals": {
- "warranty": {
- "subtotal": 0,
- "taxAmount": 0,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false,
- "isInitiated": false
}, - "refund": {
- "subtotal": 57.45,
- "taxAmount": 3.2,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false
}, - "exchange": {
- "subtotal": 0,
- "taxAmount": 0,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false,
- "isInitiated": false,
- "bonusAmount": 0
}, - "giftCard": {
- "subtotal": 0,
- "taxAmount": 0,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "bonusAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false,
- "isInitiated": false
}
}, - "flagged": false
}
]
Count total number of RMAs
Datetime format is ISO-8601 as defined in RFC 3339
Query Params that accept multiple strings should be formatted as comma-separated values
minCreateDate | string <date-time> (IsoDate) Example: minCreateDate=YYYY-MM-DDThh:mm:ss Find RMAs created on or after this date |
maxCreateDate | string <date-time> (IsoDate) Example: maxCreateDate=YYYY-MM-DDThh:mm:ss Find RMAs created on or before this date |
workflowStatus | Array of strings (RmaWorkflowStatusKey) Items Enum: "Abandoned" "Requested" "Authorized" "Canceled" "InTransit" "Delivered" "Active" "Received" "Processed" "Complete" "Rejected" Example: workflowStatus=Requested,Authorized Find only RMAs with workflowStatus in list |
returnType | Array of strings (RmaReturnType) Items Enum: "exchange" "warranty" "refund" "giftcard" Example: returnType=exchange,warranty Find only RMAs with returnType in list |
returnReasonCode | Array of strings Example: returnReasonCode=SZ,QTY Find only RMAs with return reason in list |
Array of strings Find RMAs by the rma email or order email. Case insensitive, exact match. | |
orderName | string Find only RMAs with orderName |
externalOrderNumber | string Find only RMAs by their associated external order number |
showArchived | boolean Find only archived or non-archived RMAs |
thirdPartyOnly | boolean Find only RMAs where the associated order is from a third party source (i.e. not Shopify) |
requiresAction | boolean Find RMAs that aren't currently scheduled for automatic processing. If omitted, shows all RMAs. |
onlyFlaggedRmas | boolean Find only RMAs that have been flagged |
onlyWarrantyOutOfStock | boolean Find only RMA's that are flagged with a status code of Contact Customer Support |
curl api.returnlogic.com/v1/rmas/count\ -H "Authorization: Bearer {{your_api_token}}"\
{- "count": 0
}
curl api.returnlogic.com/v1/rmas/{rmaId}\ -H "Authorization: Bearer {{your_api_token}}"\
{- "teamId": "fe9588ff-c78f-4aa3-a247-7163bcd88ddc",
- "rlRmaId": 12345,
- "rlOrderId": 87654,
- "externalOrderNumber": "12345678",
- "orderName": "RL12345678",
- "rmaEmail": "admin@returnlogic.com",
- "orderEmail": "admin@returnlogic.com",
- "orderUrl": "",
- "fromShipping": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "toShipping": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US",
- "warehouseNickname": "NorthEast-3PL"
}, - "workflowStatus": "Delivered",
- "workflowStatusId": 5,
- "rowpointer": "ec145d2c-322f-48ad-8851-6eaff9187f30",
- "orderDate": "2024-08-25T17:56:38.921Z",
- "rmaExpirationDate": "2024-11-08T17:56:38.921Z",
- "isThirdParty": false,
- "receiptImageUrl": "",
- "isArchived": false,
- "isAllProcessed": false,
- "timeline": {
- "createDate": "2024-10-02T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "inTransitUpdateDate": "2024-10-05T17:56:38.921Z",
- "deliveredUpdateDate": "2024-10-07T17:56:38.921Z",
- "createdBy": {
- "email": "shopper@shopper.com",
- "userId": "3aab23a7-a472-4fe7-b64c-b5e8e5df1dc8"
}, - "authorizedBy": {
- "email": "admin@returnlogic.com",
- "userId": "3b57f944-5d35-4167-a2b1-2a70c9c61b57"
}, - "authorizedDate": "2024-10-02T17:56:38.921Z"
}, - "rmaItems": [
- {
- "rlRmaItemId": 1108598,
- "createDate": "2024-10-09T17:56:38.921Z",
- "updateDate": "2024-10-09T17:56:38.921Z",
- "rlRmaId": 23219291,
- "externalOrderLineId": "6170390691937",
- "orderId": "2907254030433",
- "quantity": 1,
- "acceptedQuantity": 1,
- "rmaItemApproved": true,
- "returnReasonCode": "OTH",
- "productVariantBarcode": "123456789",
- "sku": "KITTEHCAR01",
- "returnReasonDescription": "Too Small",
- "returnType": "refund",
- "rmaItemReceived": false,
- "disposition": {
- "code": "RFS",
- "comment": "In good condition",
- "restockProcessed": false,
- "restockQuantity": 1
}, - "rlProductId": 12345,
- "rlProductVariantId": 67890,
- "name": "Kitteh Car",
- "variantName": "small/red"
}
], - "shippingLabel": {
- "cost": 7.25,
- "trackingNumber": "9461200897846059728722",
- "carrier": "USPS",
- "shippingMethod": "ParcelSelect"
}, - "totals": {
- "warranty": {
- "subtotal": 0,
- "taxAmount": 0,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false,
- "isInitiated": false
}, - "refund": {
- "subtotal": 57.45,
- "taxAmount": 3.2,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false
}, - "exchange": {
- "subtotal": 0,
- "taxAmount": 0,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false,
- "isInitiated": false,
- "bonusAmount": 0
}, - "giftCard": {
- "subtotal": 0,
- "taxAmount": 0,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "bonusAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false,
- "isInitiated": false
}
}, - "flagged": false
}
Update one or more RMA item(s) for an RMA
Notes:
Received
.Received
and the RMA matches your settings, then the RMA may be automatically processed.rlRmaId required | integer <int32> RMA ID |
RMA Fulfillment data
required | Array of objects (UpdateRmaFulfillmentItem) |
{- "rmaItems": [
- {
- "rlRmaItemId": 0,
- "disposition": {
- "code": "string",
- "description": "string",
- "comment": "string"
}, - "itemReceived": true
}
]
}
{- "teamId": "fe9588ff-c78f-4aa3-a247-7163bcd88ddc",
- "rlRmaId": 12345,
- "rlOrderId": 87654,
- "externalOrderNumber": "12345678",
- "orderName": "RL12345678",
- "rmaEmail": "admin@returnlogic.com",
- "orderEmail": "admin@returnlogic.com",
- "orderUrl": "",
- "fromShipping": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "toShipping": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US",
- "warehouseNickname": "NorthEast-3PL"
}, - "workflowStatus": "Delivered",
- "workflowStatusId": 5,
- "rowpointer": "ec145d2c-322f-48ad-8851-6eaff9187f30",
- "orderDate": "2024-08-25T17:56:38.921Z",
- "rmaExpirationDate": "2024-11-08T17:56:38.921Z",
- "isThirdParty": false,
- "receiptImageUrl": "",
- "isArchived": false,
- "isAllProcessed": false,
- "timeline": {
- "createDate": "2024-10-02T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "inTransitUpdateDate": "2024-10-05T17:56:38.921Z",
- "deliveredUpdateDate": "2024-10-07T17:56:38.921Z",
- "createdBy": {
- "email": "shopper@shopper.com",
- "userId": "3aab23a7-a472-4fe7-b64c-b5e8e5df1dc8"
}, - "authorizedBy": {
- "email": "admin@returnlogic.com",
- "userId": "3b57f944-5d35-4167-a2b1-2a70c9c61b57"
}, - "authorizedDate": "2024-10-02T17:56:38.921Z"
}, - "rmaItems": [
- {
- "rlRmaItemId": 1108598,
- "createDate": "2024-10-09T17:56:38.921Z",
- "updateDate": "2024-10-09T17:56:38.921Z",
- "rlRmaId": 23219291,
- "externalOrderLineId": "6170390691937",
- "orderId": "2907254030433",
- "quantity": 1,
- "acceptedQuantity": 1,
- "rmaItemApproved": true,
- "returnReasonCode": "OTH",
- "productVariantBarcode": "123456789",
- "sku": "KITTEHCAR01",
- "returnReasonDescription": "Too Small",
- "returnType": "refund",
- "rmaItemReceived": false,
- "disposition": {
- "code": "RFS",
- "comment": "In good condition",
- "restockProcessed": false,
- "restockQuantity": 1
}, - "rlProductId": 12345,
- "rlProductVariantId": 67890,
- "name": "Kitteh Car",
- "variantName": "small/red"
}
], - "shippingLabel": {
- "cost": 7.25,
- "trackingNumber": "9461200897846059728722",
- "carrier": "USPS",
- "shippingMethod": "ParcelSelect"
}, - "totals": {
- "warranty": {
- "subtotal": 0,
- "taxAmount": 0,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false,
- "isInitiated": false
}, - "refund": {
- "subtotal": 57.45,
- "taxAmount": 3.2,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false
}, - "exchange": {
- "subtotal": 0,
- "taxAmount": 0,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false,
- "isInitiated": false,
- "bonusAmount": 0
}, - "giftCard": {
- "subtotal": 0,
- "taxAmount": 0,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "bonusAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false,
- "isInitiated": false
}
}, - "flagged": false
}
Flag the RMA for advanced filtering in the originate and collector lists
Notes: Flagging is useful for raising attention on RMA's that have special exceptions that have to be communicated across the team. Once a RMA is flagged it cannot be unflagged
rlRmaId required | integer <int32> RMA ID |
{- "teamId": "fe9588ff-c78f-4aa3-a247-7163bcd88ddc",
- "rlRmaId": 12345,
- "rlOrderId": 87654,
- "externalOrderNumber": "12345678",
- "orderName": "RL12345678",
- "rmaEmail": "admin@returnlogic.com",
- "orderEmail": "admin@returnlogic.com",
- "orderUrl": "",
- "fromShipping": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US"
}, - "toShipping": {
- "address1": "395 St Johns Church Rd",
- "address2": "",
- "city": "Camp Hill",
- "region": "Pennsylvania",
- "regionCode": "PA",
- "postcode": "17011",
- "country": "United States Of America",
- "countryCode": "US",
- "warehouseNickname": "NorthEast-3PL"
}, - "workflowStatus": "Delivered",
- "workflowStatusId": 5,
- "rowpointer": "ec145d2c-322f-48ad-8851-6eaff9187f30",
- "orderDate": "2024-08-25T17:56:38.921Z",
- "rmaExpirationDate": "2024-11-08T17:56:38.921Z",
- "isThirdParty": false,
- "receiptImageUrl": "",
- "isArchived": false,
- "isAllProcessed": false,
- "timeline": {
- "createDate": "2024-10-02T17:56:38.921Z",
- "updateDate": "2024-10-08T17:56:38.921Z",
- "inTransitUpdateDate": "2024-10-05T17:56:38.921Z",
- "deliveredUpdateDate": "2024-10-07T17:56:38.921Z",
- "createdBy": {
- "email": "shopper@shopper.com",
- "userId": "3aab23a7-a472-4fe7-b64c-b5e8e5df1dc8"
}, - "authorizedBy": {
- "email": "admin@returnlogic.com",
- "userId": "3b57f944-5d35-4167-a2b1-2a70c9c61b57"
}, - "authorizedDate": "2024-10-02T17:56:38.921Z"
}, - "rmaItems": [
- {
- "rlRmaItemId": 1108598,
- "createDate": "2024-10-09T17:56:38.921Z",
- "updateDate": "2024-10-09T17:56:38.921Z",
- "rlRmaId": 23219291,
- "externalOrderLineId": "6170390691937",
- "orderId": "2907254030433",
- "quantity": 1,
- "acceptedQuantity": 1,
- "rmaItemApproved": true,
- "returnReasonCode": "OTH",
- "productVariantBarcode": "123456789",
- "sku": "KITTEHCAR01",
- "returnReasonDescription": "Too Small",
- "returnType": "refund",
- "rmaItemReceived": false,
- "disposition": {
- "code": "RFS",
- "comment": "In good condition",
- "restockProcessed": false,
- "restockQuantity": 1
}, - "rlProductId": 12345,
- "rlProductVariantId": 67890,
- "name": "Kitteh Car",
- "variantName": "small/red"
}
], - "shippingLabel": {
- "cost": 7.25,
- "trackingNumber": "9461200897846059728722",
- "carrier": "USPS",
- "shippingMethod": "ParcelSelect"
}, - "totals": {
- "warranty": {
- "subtotal": 0,
- "taxAmount": 0,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false,
- "isInitiated": false
}, - "refund": {
- "subtotal": 57.45,
- "taxAmount": 3.2,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false
}, - "exchange": {
- "subtotal": 0,
- "taxAmount": 0,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false,
- "isInitiated": false,
- "bonusAmount": 0
}, - "giftCard": {
- "subtotal": 0,
- "taxAmount": 0,
- "discountItemsAmount": 0,
- "shippingAmount": 0,
- "otherFeeAmount": 0,
- "bonusAmount": 0,
- "total": 0,
- "isProcessed": false,
- "isManuallyProcessed": false,
- "isInitiated": false
}
}, - "flagged": false
}
Get RMA Return Type History
rlRmaItemId required | number <double> RMA Item to retrieve return history for. |
{- "returnTypeId": 0,
- "functionalReturnTypeId": 0,
- "returnTypeName": "string",
- "functionalReturnTypeName": "string",
- "returnTypeDisplayName": "string",
- "returnTypeDescription": "string",
- "returnTypeDisplayDescription": "string",
- "returnTypeDisplayPosition": 0,
- "active": true,
- "isAllowed": true,
- "returnPeriod": 0,
- "hasReturnPeriod": true,
- "returnPeriodMessage": "string",
- "shippingType": "string",
- "extendedWarranty": 0,
- "returnHistory": [
- {
- "returnTypeId": 0,
- "functionalReturnTypeId": 0,
- "returnTypeName": "string",
- "functionalReturnTypeName": "string",
- "returnTypeDisplayName": "string",
- "returnTypeDescription": "string",
- "returnTypeDisplayDescription": "string",
- "returnTypeDisplayPosition": 0,
- "active": true,
- "isAllowed": true,
- "returnPeriod": 0,
- "hasReturnPeriod": true,
- "returnPeriodMessage": "string",
- "shippingType": "string",
- "userId": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2019-08-24T14:15:22Z"
}
Add a webhook registration for the current private application.
resourceAction required | string (WebHookNotificationApiResourceAction) Enum: "rma.updated" "rma.requested" "rma.deleted" Available Notification. |
endpoint required | string Endpoint where notification should be posted to. |
active | boolean Is registration Active or Disabled? |
{- "resourceAction": "rma.updated",
- "active": true
}
{- "registrationId": "string",
- "resourceAction": "string",
- "endpoint": "string",
- "active": true,
- "createDate": "2019-08-24T14:15:22Z"
}
Update a webhook registration for the current private application.
registrationId required | string Unique ID of webhook registration. |
resourceAction required | string (WebHookNotificationApiResourceAction) Enum: "rma.updated" "rma.requested" "rma.deleted" Available Notification. |
endpoint required | string Endpoint where notification should be posted to. |
active | boolean Is registration Active or Disabled? |
{- "resourceAction": "rma.updated",
- "active": true
}
{- "registrationId": "string",
- "resourceAction": "string",
- "endpoint": "string",
- "active": true,
- "createDate": "2019-08-24T14:15:22Z"
}