Record dropped-off return items

post
/returns/rma/{rma_number}/dropoffs/{dropoff_id}/drops

This endpoint applies to dropoffs powered by AfterShip QR Code: When a shopper drops some return items at the location, the merchant's sytem should scan the QR code, extract the rma_number, dropoff_id, and then call this endpoint to mark the items as dropped.

For 3rd party droppoff service providers to call this endpoint on behalf of merchant: please note that you need to extract the organization_id and use an API Key of that specific organization.

rma_number
string
required
dropoff_id
string
required

This dropoff ID can be found in the QR code generated at AfterShip Returns.

items
array[dropoff_drop_item.v2]
external_order_item_id
string
quantity
integer
>= 1
dropped_at
string<date-time>

Created

meta
Meta

Meta data object.

code
number
required
Default:
20100
Example:
20100
type
string
required
>= 1 characters
Example:
Created
message
string
required
>= 1 characters
Example:
The request has been fulfilled and a new resource has been created.
data
dropoff_drop.v2
id
string
items
array[dropoff_drop_item.v2]
dropped_at
string<date-time>
created_at
string<date-time>
return
object
dropoff
object
Auth
:
Parameters
:
:
Body
{ "items": [ { "external_order_item_id": "string", "quantity": 1 } ], "dropped_at": "2019-08-24T14:15:22Z" }
Response Example
{ "meta": { "code": 20100, "type": "Created", "message": "The request has been fulfilled and a new resource has been created." }, "data": { "id": "string", "items": [ { "external_order_item_id": "string", "quantity": 1 } ], "dropped_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "return": { "id": "string", "rma_number": "string" }, "dropoff": { "id": "string" } } }