QUICKSTART
API Quick Start
Authentication
SignString
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
Migration
Migrate from legacy version
Migrate from 2024-07
Reference
API Overview
Returns
Get return detail by ID
get
Get return detail by RMA number
get
Get returns
get
Approve Return By RMA number
post
Approve Return By Return ID
post
Resolve Return By RMA number
post
Resolve Return By Return ID
post
Reject Return By RMA number
post
Reject Return By Return ID
post
Receive items by RMA number
post
Receive items by Return ID
post
Attach shipments by RMA number
post
Attach shipments by Return ID
post
Return Dropoffs
Record dropped-off return items
post
Return items
Update return items by Return ID
patch
Update return items By RMA number
patch
Item tags
Get item tags
get
Model
Primitive
Address
Money
Envelope
Meta
Error
Resource
Return
Return item
Item tag
Webhook
Webhook Overview
Webhook Specifications
Webhook Outgoing IPs
Webhook Signature
Support
Contact Support

Changelog

2024-10

UpdateBeforeAfter
Add new endpoints to approve return-
  • POST /returns/rma/{rma_number}/approve
  • POST /returns/returns/{return_id}/approve
    • Add new endpoints to resolve return-
  • POST /returns/rma/{rma_number}/resolve
  • POST /returns/returns/{return_id}/resolve
    • Add new endpoints to reject return-
  • POST /returns/rma/{rma_number}/reject
  • POST /returns/returns/{return_id}/reject
    • Add new endpoints to attach return shipment-
  • POST /returns/rma/{rma_number}/attach-shipments
  • POST /returns/returns/{return_id}/attach-shipments
    • Add new endpoints to receive items-
  • POST /returns/rma/{rma_number}/receive-items
  • POST /returns/returns/{return_id}/receive-items
    • Add new endpoints to update items-
  • PATCH /returns/rma/{rma_number}/items/{item_id}
  • PATCH /returns/returns/{return_id}/items/{item_id}
    • Add a new endpoint to get item tags-
  • GET /item-tags
    • Add some fields to the Return ObjectRefer to Return Object 2024-07 for more details.Refer to Return Object 2024-10 for more details.
    Rename all source_*_id to external_*_idRemove:
  • restock.items[*].source_order_item_id
  • restock.items[*].location.source_id
  • return_items[*].exchange_variant.source_product_id
  • return_items[*].exchange_variant.source_variant_id
    		• Add:
  • restock.items[*].external_order_item_id
  • restock.items[*].location.external_id
  • return_items[*].exchange_variant.external_product_id
  • return_items[*].exchange_variant.external_variant_id
    • Return item field modifiedRemove:
  • return_items[*].discounted_price_including_tax
  • return_items[*].image_urls
    		• Add:
  • return_items[*].unit_discounted_price_including_tax
  • return_items[*].product_image_urls
    • Address.country_region modified{"country_region": {"name": "USA"}}{"country_region": {"code": "USA"}}
    Address.state modified{"state": "Arkansas"}{"state": {"name": "Arkansas"}}
    Add some webhook events-Add:
  • return.approved
  • return.expired
  • return.rejected
  • return.resolved
  • return.submitted
  • return.dropoff.created
  • return.dropoff.shipment.updated
  • return.dropoff.updated
  • return.shipment.provided
  • return.shipment.recorded
  • return.shipment.updated
  • return.shipments.provided
    • Webhook payload modified-Refer to Migrate from 2024-07 for more details.

    2024-07

    UpdateBeforeAfter
    Add new endpoint to get returns by rma number-Get /returns/rma/{rma_number}
    Add new endpoint to get return by rma id-Get /returns/{rma_id}
    Add new endpoint to get returns-GET /returns
    Add new endpoint to create dropoff drops.-POST /returns/rma/{rma_number}/dropoffs/{dropoff_id}/drops
    Add new webhook event return.restock.created-return.restock.created