ReturnOrder

Represents the repair, return, or recall of product items. This object is available in API version 60.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

AccountId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The account associated with the return order.

This is a relationship field.
Relationship Name: Account
Relationship Type: Lookup
Refers To: Account

CaseId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The case associated with the return order.

This is a relationship field.
Relationship Name: Case
Relationship Type: Lookup
Refers To: Case

ContactId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The contact associated with the return order.

This is a relationship field.
Relationship Name: Contact
Relationship Type: Lookup
Refers To: Contact

Description

Type: textarea
Properties: Create, Nillable, Update
Description: The description of the return order.

DestinationLocationId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The location where the items are being returned to. For example, if the return order tracks the return of products from a technician’s van to a warehouse, the warehouse is the destination location.

This is a relationship field.
Relationship Name: DestinationLocation
Relationship Type: Lookup
Refers To: Location

ExpectedArrivalDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date when the items are expected to arrive at the destination location.

ExpirationDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date after which authorizations can’t be captured.

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view indirectly.

OrderId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The order associated with the return order. When you associated a return order with an order, you can associate the return order’s line items with order products.

This is a relationship field.
Relationship Name: Order
Relationship Type: Lookup
Refers To: Order

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: The owner of the return order.

This is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User

ProductRequestId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The product request associated with the return order. When you associated a return order with a product request, you can associate the return order’s line items with the product request’s line items. A return order might be related to a product request if the return order tracks the return of unused products or products to be repaired or replaced. For example, a technician creates a product request for three motors to prepare for a field visit. If the technician finds that only two motors are needed, they can create a return order to return the third to the original location, and list the product request in this field.

This is a relationship field.
Relationship Name: ProductRequest
Relationship Type: Lookup
Refers To: ProductRequest

ReturnOrderNumber

Type: string
Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
Description: The auto-generated number identifying the return order.

ReturnedById

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The user returning the items.

This is a relationship field.
Relationship Name: ReturnedBy
Relationship Type: Lookup
Refers To: User

ShipFromAddress

Type: address
Properties: Filter, Nillable
Description: The return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address.

ShipFromCity

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The city of the return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address.

ShipFromCountry

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The country of the return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address.

ShipFromGeocodeAccuracy

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Accuracy level of the geocode for the return shipping address.

ShipFromLatitude

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: Used with Longitude to specify the precise geolocation of the return shipping address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.

ShipFromLongitude

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: Used with Latitude to specify the precise geolocation of the return shipping address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.

ShipFromPostalCode

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The postal code of the return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address.

ShipFromState

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The state of the return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address.

ShipFromStreet

Type: textarea
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The street of the return shipping address. This address tracks the location of the items at the start of the return or repair. For example, if a customer is returning an item, the Ship From address is the customer’s address.

ShipmentType

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: The type of shipment associated with the return order. Available values are:
- Standard (default value)
- Rush
- Overnight
- Next Business Day
- Pick Up

SourceLocationId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The items’ location at the start of the return or repair. For example, if the return order tracks the return of products from a technician’s service center to a warehouse, the service center is the source location.

This is a relationship field.
Relationship Name: SourceLocation
Relationship Type: Lookup
Refers To: Location

Status

Type: picklist
Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description: The status of the return order. Available values are:
- Draft
- Submitted
- Approved
- Canceled
- Closed

StatusCategory

Type: picklist
Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description: Status category of the return order. Processing of the return order depends on this value. Each status category corresponds to one or more statuses.
Possible values:
- Activated
- Canceled
- Closed
- Draft