Create a return

POST {{baseUrl}}/brand/:brand_domain/return-portal/incoming

This endpoint creates a new return parcel based on an outgoing parcel. The outgoing parcel and related data needed to make a request to this endpoint can be retrieved with /brand/{brand_domain}/return-portal/outgoing. This also returns the JWT Token needed for authentication with this endpoint

Request Body

{"reason"=>"<integer>", "message"=>"<string>", "outgoing_parcel"=>"<integer>", "refund"=>{"refund_type"=>{"code"=>"exchange"}, "message"=>"<string>"}, "delivery_option"=>"in_store", "products"=>[{"description"=>"<string>", "product_id"=>"<string>", "quantity"=>"<integer>", "value"=>"<number>", "hs_code"=>"<string>", "origin_country"=>"<string>", "sku"=>"<string>", "weight"=>"<string>", "return_reason"=>"<integer>", "return_message"=>"<string>"}, {"description"=>"<string>", "product_id"=>"<string>", "quantity"=>"<integer>", "value"=>"<number>", "hs_code"=>"<string>", "origin_country"=>"<string>", "sku"=>"<string>", "weight"=>"<string>", "return_reason"=>"<integer>", "return_message"=>"<string>"}], "incoming_parcel"=>{"from_address_1"=>"<string>", "from_city"=>"<string>", "from_company_name"=>"<string>", "from_country"=>"<string>", "from_email"=>"<string>", "from_house_number"=>"<string>", "from_name"=>"<string>", "from_postal_code"=>"<string>", "from_telephone"=>"<string>", "collo_count"=>1, "from_address_2"=>"<string>", "from_country_state"=>"<string>"}, "service_point"=>{"id"=>"<long>"}, "selected_functionalities"=>{"first_mile"=>"dropoff"}, "selected_carrier_code"=>"<string>", "pickup_date"=>"<string>", "images"=>[{"filename"=>"<uri>", "product_id"=>"<string>", "description"=>"<string>"}, {"filename"=>"<uri>", "product_id"=>"<string>", "description"=>"<string>"}], "customs_information"=>{"customs_invoice_nr"=>"<string>", "export_type"=>"commercial_b2c", "invoice_date"=>"<date>", "discount_granted"=>"<string>", "freight_costs"=>"<string>", "insurance_costs"=>"<string>", "other_costs"=>"<string>", "general_notes"=>"<string>", "additional_declaration_statements"=>["<string>", "<string>"], "importer_of_record"=>{"name"=>"<string>", "address_1"=>"<string>", "city"=>"<string>", "postal_code"=>"<string>", "country_code"=>"<string>", "company_name"=>"<string>", "address_2"=>"<string>", "house_number"=>"<string>", "country_state"=>"<string>", "telephone"=>"<string>", "email"=>"<string>"}, "tax_numbers"=>{"sender"=>[{"name"=>"FTZ", "country_code"=>"<string>", "value"=>"<string>"}, {"name"=>"FED", "country_code"=>"<string>", "value"=>"<string>"}], "receiver"=>[{"name"=>"NID", "country_code"=>"<string>", "value"=>"<string>"}, {"name"=>"DLI", "country_code"=>"<string>", "value"=>"<string>"}], "importer_of_record"=>[{"name"=>"GST", "country_code"=>"<string>", "value"=>"<string>"}, {"name"=>"DTF", "country_code"=>"<string>", "value"=>"<string>"}]}, "return_data"=>{"return_postal_code"=>"<string>", "outbound_tracking_number"=>"<string>", "outbound_shipment_date"=>"<date>", "outbound_carrier_name"=>"<string>"}}}

HEADERS

RESPONSES

status: OK

{"poller_url":"\u003cstring\u003e","return":"\u003cinteger\u003e","incoming_parcels":["\u003cinteger\u003e","\u003cinteger\u003e"],"payment_url":"\u003cstring\u003e"}