Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Shipments

Return a shipment

This will trigger any Returns Rules configured within a Return Profile for that Offer.

post/shipments/{shipment_id}/return

Request body

date_returnstring date-time required

Set the date the shipment was returned.

Example request

{
  "date_return": "2023-04-01 00:00:00"
}

Response

OK

shipment_idinteger
connection_shipment_idstring nullable
customer_idinteger
order_idinteger
shipment_prepaid_cycleinteger
shipment_status_id1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9
  • 1 - Pending Post
  • 2 - Pending Tracking
  • 3 - Cancelled
  • 4 - Shipped
  • 5 - Error
  • 6 - Delivered
  • 7 - Declined
  • 8 - Pending Transaction
  • 9 - Skipped
transaction_charge_idinteger
connection_idinteger nullable
fulfillment_idstring nullable
shipment_tracking_idstring nullable
carrier_idnull | 1 | 2 | 3 | 4 | 5 | 6 | 8 | 9 nullable
  • 1 - USPS
  • 2 - UPS
  • 3 - FedEx
  • 4 - DHL eCommerce
  • 5 - UPS Mail Innovations
  • 6 - Canada Post
  • 8 - Australia Post
  • 9 - Hermes
shipping_profile_idinteger nullable
date_cancelstring date-time nullable
date_scheduledstring date-time
date_completestring date-time nullable
date_scanstring date-time nullable
date_deliverstring date-time nullable
date_returnstring date-time nullable
date_skipstring date-time nullable
date_rmastring date-time nullable
shipment_rmastring nullable
cancel_type_idinteger nullable
skip_type_idinteger nullable
shipping_reship_type_idnull | 1 | 2 | 3 | 4 nullable
  • 1 - Did not receive package
  • 2 - Damaged Items
  • 3 - Items Incorrect
  • 4 - Quantity Incorrect
shipment_parent_type_idnull | 1 | 2 | 3 | 4 nullable
  • 1 - Reship
  • 2 - Reward
  • 3 - Gift
  • 4 - Free
date_createdstring date-time
created_byinteger
date_modifiedstring date-time
modified_byinteger
shipment_notesstring nullable
connection_request_textstring nullable
connection_response_textstring nullable

Example response

{
  "date_cancel": "2023-04-01 00:00:00",
  "date_scheduled": "2023-04-01 00:00:00",
  "date_complete": "2023-04-01 00:00:00",
  "date_scan": "2023-04-01 00:00:00",
  "date_deliver": "2023-04-01 00:00:00",
  "date_return": "2023-04-01 00:00:00",
  "date_skip": "2023-04-01 00:00:00",
  "date_rma": "2023-04-01 00:00:00",
  "date_created": "2023-04-01 00:00:00",
  "date_modified": "2023-04-01 00:00:00",
  "customer_address_billing": {
    "date_created": "2023-04-01 00:00:00",
    "date_modified": "2023-04-01 00:00:00"
  },
  "customer_address_shipping": {
    "date_created": "2023-04-01 00:00:00",
    "date_modified": "2023-04-01 00:00:00"
  },
  "tracking_history": [
    {
      "date": "2023-04-01 00:00:00"
    }
  ]
}