# RT04 - Patch update returns

Endpoint: PUT /api/returns

## Query parameters:

  - `shop_id` (integer)
    Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

## Request fields (application/json):

  - `returns` (array, required)
    Returns to be updated, maximum number of returns per call: 100

  - `returns.id` (string, required)
    Return id

  - `returns.label_url` (string)
    Return label URL

  - `returns.method_code` (string)
    Return method code. Can be provided only when the setting Allow store accounts to update the return method before acceptance is enabled.

Enum: "RETURN_METHOD_BY_MAIL", "RETURN_METHOD_DROP_OFF_POINT", "RETURN_METHOD_HOME_PICKUP", "RETURN_METHOD_IN_STORE", "RETURN_METHOD_RETURNLESS"

  - `returns.return_address` (object)
    The address where items must be returned

  - `returns.return_address.address` (object)
    The return address details

  - `returns.return_address.address.city` (string, required)
    City

  - `returns.return_address.address.country_iso_code` (string, required)
    Country ISO code

Enum: "AFG", "ALA", "ALB", "DZA", "ASM", "AND", "AGO", "AIA", "ATA", "ATG", "ARG", "ARM", "ABW", "AUS", "AUT", "AZE", "BHS", "BHR", "BGD", "BRB", "BLR", "BEL", "BLZ", "BEN", "BMU", "BTN", "BOL", "BES", "BIH", "BWA", "BVT", "BRA", "IOT", "BRN", "BGR", "BFA", "BDI", "KHM", "CMR", "CAN", "CPV", "CYM", "CAF", "TCD", "CHL", "CHN", "CXR", "CCK", "COL", "COM", "COG", "COD", "COK", "CRI", "CIV", "HRV", "CUB", "CUW", "CYP", "CZE", "DNK", "DJI", "DMA", "DOM", "ECU", "EGY", "SLV", "GNQ", "ERI", "EST", "ETH", "FLK", "FRO", "FJI", "FIN", "FRA", "GUF", "PYF", "ATF", "GAB", "GMB", "GEO", "DEU", "GHA", "GIB", "GRC", "GRL", "GRD", "GLP", "GUM", "GTM", "GGY", "GIN", "GNB", "GUY", "HTI", "HMD", "VAT", "HND", "HKG", "HUN", "ISL", "IND", "IDN", "IRQ", "IRL", "IMN", "ISR", "ITA", "JAM", "JPN", "JEY", "JOR", "KAZ", "KEN", "KIR", "KOR", "KWT", "KGZ", "LAO", "LVA", "LBN", "LSO", "LBR", "LBY", "LIE", "LTU", "LUX", "MAC", "MKD", "MDG", "MWI", "MYS", "MDV", "MLI", "MLT", "MHL", "MTQ", "MRT", "MUS", "MYT", "MEX", "FSM", "MDA", "MCO", "MNG", "MNE", "MSR", "MAR", "MOZ", "MMR", "NAM", "NRU", "NPL", "NLD", "NCL", "NZL", "NIC", "NER", "NGA", "NIU", "NFK", "MNP", "NOR", "OMN", "PAK", "PLW", "PSE", "PAN", "PNG", "PRY", "PER", "PHL", "PCN", "POL", "PRT", "PRI", "QAT", "REU", "ROU", "RUS", "RWA", "BLM", "SHN", "KNA", "LCA", "MAF", "SPM", "VCT", "WSM", "SMR", "STP", "SAU", "SEN", "SRB", "SYC", "SLE", "SGP", "SXM", "SVK", "SVN", "SLB", "SOM", "ZAF", "SGS", "SSD", "ESP", "LKA", "SUR", "SJM", "SWZ", "SWE", "CHE", "TWN", "TJK", "TZA", "THA", "TLS", "TGO", "TKL", "TON", "TTO", "TUN", "TUR", "TKM", "TCA", "TUV", "UGA", "UKR", "ARE", "GBR", "USA", "UMI", "URY", "UZB", "VUT", "VEN", "VNM", "VGB", "VIR", "WLF", "YEM", "ZMB", "ZWE"

  - `returns.return_address.address.state` (string)
    State

  - `returns.return_address.address.street1` (string, required)
    First line of the return address

  - `returns.return_address.address.street2` (string)
    Second line of the return address

  - `returns.return_address.address.zip_code` (string)
    Address zip code, mandatory except for: Bahrain, Chile, Egypt, Hong-Kong, Kuwait, Oman, Peru, Qatar, Saudi Arabia, United Arab Emirates or Uruguay

  - `returns.rma` (string)
    Return RMA

  - `returns.tracking` (object)
    Tracking information

  - `returns.tracking.carrier_code` (string)
    Carrier Code

  - `returns.tracking.carrier_name` (string)
    Carrier name

  - `returns.tracking.carrier_standard_code` (string)
    Carrier Standard Code

  - `returns.tracking.tracking_number` (string)
    Tracking number

  - `returns.tracking.tracking_url` (string)
    Url tracking

## Response 200 fields (application/json):

  - `return_errors` (array)
    Returns update errors

  - `return_errors.id` (string)
    Return id

  - `return_errors.message` (string)
    Error message

  - `return_success` (array)
    Returns update success

  - `return_success.date_created` (string, required)
    Return creation date

  - `return_success.description` (string)
    Description

  - `return_success.documents` (array)
    Return documents

  - `return_success.documents.id` (integer, required)
    Return document id

  - `return_success.documents.type` (string, required)
    Return document type

  - `return_success.id` (string, required)
    Return id

  - `return_success.label_url` (string)
    Label URL

  - `return_success.last_updated` (string, required)
    Return last updated date

  - `return_success.method_code` (string, required)
    Return method code

Enum: "RETURN_METHOD_BY_MAIL", "RETURN_METHOD_DROP_OFF_POINT", "RETURN_METHOD_HOME_PICKUP", "RETURN_METHOD_IN_STORE", "RETURN_METHOD_RETURNLESS"

  - `return_success.order_commercial_id` (string, required)
    Order commercial id

  - `return_success.order_id` (string, required)
    Order id

  - `return_success.reason_code` (string)
    Return reason code

Enum: "RETURN_BROKEN_ITEM", "RETURN_CHANGED_MIND", "RETURN_COUNTERFEIT_ITEM", "RETURN_DAMAGED_PACKAGING", "RETURN_DEFECTIVE_ITEM", "RETURN_DELIVERED_PRODUCT_DIFFERENT", "RETURN_MISSING_ITEM", "RETURN_OTHER", "RETURN_CM_DONT_WANT", "RETURN_CM_DONT_LIKE", "RETURN_CM_QUALITY", "RETURN_DPD_WRONG_SIZE", "RETURN_DPD_WRONG_COLOR", "RETURN_DEFECTIVE_ON_ARRIVAL", "RETURN_PRODUCT_DOES_NOT_FIT", "RETURN_PDNT_TOO_BIG", "RETURN_PDNT_TOO_SMALL", "RETURN_INACCURATE_ITEM_DESCRIPTION", "RETURN_WARRANTY"

  - `return_success.rejection_reason_code` (string)
    Return rejection reason code

Enum: "RETURN_REJECTION_NOT_ELIGIBLE", "RETURN_REJECTION_NOT_NEEDED", "RETURN_REJECTION_WINDOW_CLOSED"

  - `return_success.return_address` (object, required)
    The address where items must be returned

  - `return_success.return_address.city` (string, required)
    City

  - `return_success.return_address.country_iso_code` (string, required)
    Country ISO code

  - `return_success.return_address.state` (string)
    State

  - `return_success.return_address.street1` (string, required)
    First line of the return address

  - `return_success.return_address.street2` (string)
    Second line of the return address

  - `return_success.return_address.zip_code` (string, required)
    Zip code

  - `return_success.return_lines` (array, required)
    Return lines

  - `return_success.return_lines.compliance` (array)
    Compliance

  - `return_success.return_lines.compliance.compliant` (boolean, required)
    Compliant

  - `return_success.return_lines.compliance.non_compliance_additional_info` (string)
    Non compliance additional info

  - `return_success.return_lines.compliance.non_compliance_reason_code` (string)
    Non compliance reason code

  - `return_success.return_lines.order_line_id` (string, required)
    Order line id

  - `return_success.return_lines.quantity` (integer, required)
    Quantity

  - `return_success.return_lines.reason_code` (string, required)
    Return reason code for this line.

Enum: "RETURN_BROKEN_ITEM", "RETURN_CHANGED_MIND", "RETURN_COUNTERFEIT_ITEM", "RETURN_DAMAGED_PACKAGING", "RETURN_DEFECTIVE_ITEM", "RETURN_DELIVERED_PRODUCT_DIFFERENT", "RETURN_MISSING_ITEM", "RETURN_OTHER", "RETURN_CM_DONT_WANT", "RETURN_CM_DONT_LIKE", "RETURN_CM_QUALITY", "RETURN_DPD_WRONG_SIZE", "RETURN_DPD_WRONG_COLOR", "RETURN_DEFECTIVE_ON_ARRIVAL", "RETURN_PRODUCT_DOES_NOT_FIT", "RETURN_PDNT_TOO_BIG", "RETURN_PDNT_TOO_SMALL", "RETURN_INACCURATE_ITEM_DESCRIPTION", "RETURN_WARRANTY"

  - `return_success.rma` (string)
    Return RMA

  - `return_success.state` (string, required)
    Return state

Enum: "WAITING_ACCEPTANCE", "IN_PROGRESS", "REFUSED", "RECEIVED", "NO_RECEPTION", "CLOSED", "CANCELED"

  - `return_success.tracking` (object)
    Return tracking details

  - `return_success.tracking.carrier_code` (string)
    Carrier code

  - `return_success.tracking.carrier_name` (string)
    Carrier name

  - `return_success.tracking.carrier_standard_code` (string)
    Carrier standard code

  - `return_success.tracking.tracking_number` (string)
    Tracking number

  - `return_success.tracking.tracking_url` (string)
    Return tracking URL