> ## Documentation Index > Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt > Use this file to discover all available pages before exploring further. # Reverse Logistics Suggestions > Reverse Logistics Suggestions ## OpenAPI ````yaml /openapi/openapi_orderrouting.json post /commerce/orders/orderrouting/api/v1/routing/reverseLogisticsSuggestion openapi: 3.0.1 info: description: |-

ORDER ROUTING

Although the Order Routing interface is the best place to configure order routing rules, some aspects of routing can be managed through REST API calls when convenient.

Use the Data List resource to define the cases for which routing filters are applied.

Use the Routing Filter resource to configure sets of rules that filter out fulfillers that do not match given order criteria.

Use the Routing Group resource to manage and sort location groups specifically in context of routing preferences.

Use the general Routing resource to test your order routing configurations, such as by retrieving a list of eligible fulfillers for a certain order based on set routing rules or obtain a log of order routing decisions.

title: Order Routing version: 0.0.1 servers: - description: Kibo Base URL url: '{baseUrl}/api' variables: baseUrl: default: https://t1000000.sb.usc1.gcp.kibocommerce.com description: Base URL security: - bearerAuth: [] tags: - description: Classic UI API - Tenant-level routing configuration name: OrderRoutingTenant - description: Classic UI API - Manage custom data lists name: OrderRoutingDataList - description: Classic UI API - Order Routing Settings configuration name: OrderRoutingSettings - description: New UI API - Manage routing scenarios name: OrderRoutingScenario - description: Classic UI API - Location information name: OrderRoutingLocation - description: Classic UI API - Environment configuration name: OrderRoutingEnvironment - description: New UI API - Export and import strategies name: OrderRoutingStrategyExport - description: Classic UI API - Post-routing actions name: OrderRoutingAfterAction - description: New UI API - Filter data for routing scenarios name: OrderRoutingFilterData - description: New UI API - Manage routing strategies name: OrderRoutingStrategy - description: New UI API - Manage custom data lists for filtering name: OrderRoutingCustomDataList - description: Classic UI API - Manage routing groups name: OrderRoutingGroup - description: Classic UI API - Configure sorting rules name: OrderRoutingSort - description: Classic UI API - Routing testing and debugging name: Routing - description: New UI API - Estimated delivery date routing name: OrderRoutingEDD - description: Classic UI API - Site-specific routing configuration name: OrderRoutingSite - description: Classic UI API - Configure routing filters name: OrderRoutingFilter paths: /commerce/orders/orderrouting/api/v1/routing/reverseLogisticsSuggestion: post: tags: - Routing summary: Reverse Logistics Suggestions description: Reverse Logistics Suggestions parameters: - in: query name: returnSuggestionLog required: false schema: default: false type: boolean - description: Tenant in: header name: x-vol-tenant required: true schema: format: int32 type: integer - description: Site in: header name: x-vol-site required: true schema: format: int32 type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/ReturnSuggestionRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReverseLogisticsSuggestionResponse' description: OK '400': content: '*/*': schema: $ref: '#/components/schemas/APIErrorResponse' description: Bad Request '403': content: '*/*': schema: $ref: '#/components/schemas/APIErrorResponse' description: Forbidden '409': content: '*/*': schema: $ref: '#/components/schemas/APIErrorResponse' description: Conflict '410': content: '*/*': schema: $ref: '#/components/schemas/APIErrorResponse' description: Gone '500': content: '*/*': schema: $ref: '#/components/schemas/APIErrorResponse' description: Internal Server Error components: schemas: ReturnSuggestionRequest: properties: bundlingStrategy: enum: - ITEM_DEPENDENCY type: string customData: additionalProperties: type: string type: object environmentID: format: int32 type: integer exclusionListLocationCode: items: $ref: '#/components/schemas/ExclusionListEntryLocationCode' type: array extendedCustomerInfo: $ref: '#/components/schemas/ExtendedCustomerInfo' extendedOrderInfo: $ref: '#/components/schemas/ExtendedOrderInfo' externalResponseID: type: string fraud: format: int32 type: integer isExpress: type: boolean items: items: $ref: '#/components/schemas/ReverseLogisticsItem' type: array locationCodeWhiteList: items: type: string type: array orderID: format: int32 type: integer orderType: enum: - DIRECTSHIP - TRANSFER - STH_CONSOLIDATED - RETURN - DISPOSITION - DELIVERY - BOPIS type: string returnID: format: int32 type: integer shippingAddress: $ref: '#/components/schemas/OrderRoutingShippingAddress' strategyID: type: string tags: additionalProperties: type: string type: object total: type: number required: - items - orderType - total type: object ReverseLogisticsSuggestionResponse: properties: externalResponseID: type: string responseID: format: int32 type: integer reverseLogisticsSuggestions: additionalProperties: $ref: '#/components/schemas/ReturnAssignmentSuggestion' type: object route: enum: - DIRECTSHIP - TRANSFER - STH_CONSOLIDATED - RETURN - DISPOSITION - DELIVERY - BOPIS type: string stateChangeSuggestions: additionalProperties: $ref: '#/components/schemas/ReverseLogisticsStateChangeSuggestion' type: object suggestionLog: $ref: '#/components/schemas/SuggestionLog' type: object APIErrorResponse: properties: additionalInfo: type: string errorMessage: type: string type: object ExclusionListEntryLocationCode: properties: locationCode: type: string orderItemID: format: int32 type: integer type: object ExtendedCustomerInfo: properties: accountType: type: string attributes: items: $ref: '#/components/schemas/OrderRoutingAttribute' type: array companyOrOrganization: type: string customerId: type: string customerSinceDate: format: date-time type: string externalId: type: string segments: items: type: string type: array taxExempt: type: boolean taxId: type: string type: object ExtendedOrderInfo: properties: attributes: items: $ref: '#/components/schemas/OrderRoutingAttribute' type: array orderId: type: string type: type: string type: object ReverseLogisticsItem: properties: condition: type: string customItemData: additionalProperties: type: object type: object dispositionCondition: type: string extendedProductInfo: $ref: '#/components/schemas/ExtendedProductInfo' height: format: double type: number itemDependency: format: int32 type: integer length: format: double type: number orderItemID: format: int32 type: integer partNumber: type: string productTitle: type: string quantity: format: int32 type: integer returnReason: type: string serialNumber: type: string sku: type: string tags: additionalProperties: type: string type: object taxable: type: boolean upc: type: string weight: format: double type: number width: format: double type: number type: object OrderRoutingShippingAddress: properties: addressID: format: int32 type: integer addressLine1: type: string city: type: string countryCode: type: string customerID: format: int32 type: integer latitude: format: double type: number longitude: format: double type: number phone: type: string postalCode: type: string state: type: string type: object ReturnAssignmentSuggestion: properties: items: items: $ref: '#/components/schemas/ReverseLogisticsAssignmentSuggestionItem' type: array locationCode: type: string locationID: format: int32 type: integer route: enum: - DIRECTSHIP - TRANSFER - STH_CONSOLIDATED - RETURN - DISPOSITION - DELIVERY - BOPIS type: string type: object ReverseLogisticsStateChangeSuggestion: properties: dispositionCondition: type: string orderItemID: format: int32 type: integer quantity: format: int32 type: integer returnReason: type: string stateChange: enum: - CANCEL - CUSTOMER_CARE - AVAILABLE - BACKORDER type: string type: object SuggestionLog: properties: created: format: date-time type: string creatorUsername: type: string environmentID: format: int32 type: integer events: items: $ref: '#/components/schemas/SuggestionEvent' type: array externalResponseID: type: string fieldsForNewEddSuggestionRequest: $ref: '#/components/schemas/NewEddRequestSuggestionEvent' fieldsForNewReturnsSuggestionRequest: $ref: '#/components/schemas/NewReverseLogisticsRequestSuggestionEvent' fieldsForNewSuggestionRequest: $ref: '#/components/schemas/NewRequestSuggestionEvent' orderID: format: int32 type: integer orderTypeCategory: enum: - STANDARD - REVERSE_LOGISTICS - ESTIMATED_DELIVERY_DATE - EDD_SUGGESTION type: string pathString: type: string persisted: type: boolean returnID: format: int32 type: integer siteID: format: int32 type: integer suggestionID: format: int32 type: integer tenantID: format: int32 type: integer updated: format: date-time type: string updaterUsername: type: string userContext: $ref: '#/components/schemas/UserContextInformation' required: - environmentID - siteID - tenantID type: object OrderRoutingAttribute: properties: attributeFQN: type: string attributeValues: items: type: string type: array type: object ExtendedProductInfo: properties: attributes: items: $ref: '#/components/schemas/OrderRoutingAttribute' type: array type: object ReverseLogisticsAssignmentSuggestionItem: properties: dispositionCondition: type: string orderItemID: format: int32 type: integer quantity: format: int32 type: integer returnReason: type: string type: object SuggestionEvent: properties: causeID: format: int32 type: integer errors: items: type: string type: array name: type: string type: enum: - NEW_REQUEST - ROUTE_SELECTED - MAKE_LOCATIONS_AVAILABLE - NO_ROUTE_FOUND - REMOVED_INACTIVE_LOCATIONS - REMOVED_ON_HOLD_LOCATIONS - REMOVED_OVERFULFILLED_LOCATIONS - GROUP - GROUP_FILTER - GROUP_SORT - FILTER - SORT - AFTER_ACTION - FOUND_FULL_ORDER_LOCATION - RESPONSE - AFTER_ACTION_SORT - DEFAULT_RESPONSE - MAX_SPLITS_EXCEEDED - AUTO_ASSIGN_LIMIT_EXCEEDED - INVENTORY_REQUEST - REMOVED_INTERNATIONAL_LOCATIONS - SUGGESTION_UPDATED - NON_EXPRESS_LOCATIONS_FILTERED - STH_CONSOLIDATED_INITIATED - STH_CONSOLIDATED_NOT_USED - STH_CONSOLIDATED_USED - FUTURE_ATP_INITIATED - FUTURE_ATP_NOT_USED - FUTURE_ATP_USED - INVENTORY_CALL_EXCEPTION - STH_CONSOLIDATION_INVALID_LOCATION_OVERRIDE - STH_CONSOLIDATION_FORCE_OVERRIDE_INITIATED - NO_STH_CONSOLIDATION_LOCATION_FOUND - STH_CONSOLIDATION_FORCE_CLOSEST_VALID_LOCATION_FOUND - STH_CONSOLIDATION_FORCE_NO_VALID_LOCATIONS_FOUND - STH_CONSOLIDATION_FORCE_NO_GEO_LOCATION_VALUES_FOUND - STH_CONSOLIDATION_FORCE_INVALID_SHIPPING_ADDRESS_VALUES type: string required: - type type: object NewEddRequestSuggestionEvent: properties: causeID: format: int32 type: integer errors: items: type: string type: array name: type: string request: $ref: '#/components/schemas/SuggestionRequest' type: enum: - NEW_REQUEST - ROUTE_SELECTED - MAKE_LOCATIONS_AVAILABLE - NO_ROUTE_FOUND - REMOVED_INACTIVE_LOCATIONS - REMOVED_ON_HOLD_LOCATIONS - REMOVED_OVERFULFILLED_LOCATIONS - GROUP - GROUP_FILTER - GROUP_FILTER_LOGICAL_GROUP - GROUP_FILTER_LOGICAL_GROUP_MISSING_ROOT - GROUP_SORT - FILTER - SORT - AFTER_ACTION - FOUND_FULL_ORDER_LOCATION - RESPONSE - AFTER_ACTION_SORT - DEFAULT_RESPONSE - MAX_SPLITS_EXCEEDED - AUTO_ASSIGN_LIMIT_EXCEEDED - INVENTORY_REQUEST - REMOVED_INTERNATIONAL_LOCATIONS - SUGGESTION_UPDATED - NON_EXPRESS_LOCATIONS_FILTERED - STH_CONSOLIDATED_INITIATED - STH_CONSOLIDATED_NOT_USED - STH_CONSOLIDATED_USED - FUTURE_ATP_INITIATED - FUTURE_ATP_NOT_USED - FUTURE_ATP_USED - INVENTORY_CALL_EXCEPTION - STH_CONSOLIDATION_INVALID_LOCATION_OVERRIDE - STH_CONSOLIDATION_FORCE_OVERRIDE_INITIATED - NO_STH_CONSOLIDATION_LOCATION_FOUND - CONSOLIDATION_FILTER_MINIMIZATION_VALIDATION - STH_CONSOLIDATION_FORCE_CLOSEST_VALID_LOCATION_FOUND - STH_CONSOLIDATION_FORCE_NO_VALID_LOCATIONS_FOUND - STH_CONSOLIDATION_FORCE_NO_GEO_LOCATION_VALUES_FOUND - STH_CONSOLIDATION_FORCE_INVALID_SHIPPING_ADDRESS_VALUES - MULTIPLE_CONSOLIDATION_LOGIC_INITIATED - MULTIPLE_CONSOLIDATION_POTENTIAL_TRANSFER_ASSIGNMENTS_FOUND - MULTIPLE_CONSOLIDATION_INITIAL_CANDIDATES_FOUND - MULTIPLE_CONSOLIDATION_SKIPPED_ORIGINAL_ASSIGNMENTS - MULTIPLE_CONSOLIDATION_LOGIC_SKIPPED - MULTIPLE_CONSOLIDATION_ASSIGNMENTS_CREATED type: string required: - type type: object NewReverseLogisticsRequestSuggestionEvent: properties: causeID: format: int32 type: integer errors: items: type: string type: array name: type: string request: $ref: '#/components/schemas/ReturnSuggestionRequest' type: enum: - NEW_REQUEST - ROUTE_SELECTED - MAKE_LOCATIONS_AVAILABLE - NO_ROUTE_FOUND - REMOVED_INACTIVE_LOCATIONS - REMOVED_ON_HOLD_LOCATIONS - REMOVED_OVERFULFILLED_LOCATIONS - GROUP - GROUP_FILTER - GROUP_FILTER_LOGICAL_GROUP - GROUP_FILTER_LOGICAL_GROUP_MISSING_ROOT - GROUP_SORT - FILTER - SORT - AFTER_ACTION - FOUND_FULL_ORDER_LOCATION - RESPONSE - AFTER_ACTION_SORT - DEFAULT_RESPONSE - MAX_SPLITS_EXCEEDED - AUTO_ASSIGN_LIMIT_EXCEEDED - INVENTORY_REQUEST - REMOVED_INTERNATIONAL_LOCATIONS - SUGGESTION_UPDATED - NON_EXPRESS_LOCATIONS_FILTERED - STH_CONSOLIDATED_INITIATED - STH_CONSOLIDATED_NOT_USED - STH_CONSOLIDATED_USED - FUTURE_ATP_INITIATED - FUTURE_ATP_NOT_USED - FUTURE_ATP_USED - INVENTORY_CALL_EXCEPTION - STH_CONSOLIDATION_INVALID_LOCATION_OVERRIDE - STH_CONSOLIDATION_FORCE_OVERRIDE_INITIATED - NO_STH_CONSOLIDATION_LOCATION_FOUND - CONSOLIDATION_FILTER_MINIMIZATION_VALIDATION - STH_CONSOLIDATION_FORCE_CLOSEST_VALID_LOCATION_FOUND - STH_CONSOLIDATION_FORCE_NO_VALID_LOCATIONS_FOUND - STH_CONSOLIDATION_FORCE_NO_GEO_LOCATION_VALUES_FOUND - STH_CONSOLIDATION_FORCE_INVALID_SHIPPING_ADDRESS_VALUES - MULTIPLE_CONSOLIDATION_LOGIC_INITIATED - MULTIPLE_CONSOLIDATION_POTENTIAL_TRANSFER_ASSIGNMENTS_FOUND - MULTIPLE_CONSOLIDATION_INITIAL_CANDIDATES_FOUND - MULTIPLE_CONSOLIDATION_SKIPPED_ORIGINAL_ASSIGNMENTS - MULTIPLE_CONSOLIDATION_LOGIC_SKIPPED - MULTIPLE_CONSOLIDATION_ASSIGNMENTS_CREATED type: string required: - type type: object NewRequestSuggestionEvent: properties: causeID: format: int32 type: integer errors: items: type: string type: array name: type: string request: $ref: '#/components/schemas/SuggestionRequest' type: enum: - NEW_REQUEST - ROUTE_SELECTED - MAKE_LOCATIONS_AVAILABLE - NO_ROUTE_FOUND - REMOVED_INACTIVE_LOCATIONS - REMOVED_ON_HOLD_LOCATIONS - REMOVED_OVERFULFILLED_LOCATIONS - GROUP - GROUP_FILTER - GROUP_FILTER_LOGICAL_GROUP - GROUP_FILTER_LOGICAL_GROUP_MISSING_ROOT - GROUP_SORT - FILTER - SORT - AFTER_ACTION - FOUND_FULL_ORDER_LOCATION - RESPONSE - AFTER_ACTION_SORT - DEFAULT_RESPONSE - MAX_SPLITS_EXCEEDED - AUTO_ASSIGN_LIMIT_EXCEEDED - INVENTORY_REQUEST - REMOVED_INTERNATIONAL_LOCATIONS - SUGGESTION_UPDATED - NON_EXPRESS_LOCATIONS_FILTERED - STH_CONSOLIDATED_INITIATED - STH_CONSOLIDATED_NOT_USED - STH_CONSOLIDATED_USED - FUTURE_ATP_INITIATED - FUTURE_ATP_NOT_USED - FUTURE_ATP_USED - INVENTORY_CALL_EXCEPTION - STH_CONSOLIDATION_INVALID_LOCATION_OVERRIDE - STH_CONSOLIDATION_FORCE_OVERRIDE_INITIATED - NO_STH_CONSOLIDATION_LOCATION_FOUND - CONSOLIDATION_FILTER_MINIMIZATION_VALIDATION - STH_CONSOLIDATION_FORCE_CLOSEST_VALID_LOCATION_FOUND - STH_CONSOLIDATION_FORCE_NO_VALID_LOCATIONS_FOUND - STH_CONSOLIDATION_FORCE_NO_GEO_LOCATION_VALUES_FOUND - STH_CONSOLIDATION_FORCE_INVALID_SHIPPING_ADDRESS_VALUES - MULTIPLE_CONSOLIDATION_LOGIC_INITIATED - MULTIPLE_CONSOLIDATION_POTENTIAL_TRANSFER_ASSIGNMENTS_FOUND - MULTIPLE_CONSOLIDATION_INITIAL_CANDIDATES_FOUND - MULTIPLE_CONSOLIDATION_SKIPPED_ORIGINAL_ASSIGNMENTS - MULTIPLE_CONSOLIDATION_LOGIC_SKIPPED - MULTIPLE_CONSOLIDATION_ASSIGNMENTS_CREATED type: string required: - type type: object UserContextInformation: properties: environmentID: format: int32 type: integer loaded: type: boolean pathString: type: string siteID: format: int32 type: integer siteService: $ref: '#/components/schemas/SiteService' tenantID: format: int32 type: integer tenantService: $ref: '#/components/schemas/TenantService' type: object SuggestionRequest: properties: bundlingStrategy: enum: - ITEM_DEPENDENCY type: string cartID: type: string customData: additionalProperties: type: string type: object environmentID: format: int32 type: integer exclusionListLocationCode: items: $ref: '#/components/schemas/ExclusionListEntryLocationCode' type: array extendedCustomerInfo: $ref: '#/components/schemas/ExtendedCustomerInfo' extendedOrderInfo: $ref: '#/components/schemas/ExtendedOrderInfo' externalResponseID: type: string forceSTHConsolidationOnSplitShipments: type: boolean fraud: format: int32 type: integer futureDateLimit: format: date-time type: string futureExclusionListLocationCode: items: $ref: '#/components/schemas/ExclusionListEntryLocationCode' type: array inventoryRequestType: enum: - ALL - ANY - PARTIAL - ALL_STORES type: string isExpress: type: boolean items: items: $ref: '#/components/schemas/OrderRoutingOrderItem' type: array locationCodeWhiteList: items: type: string type: array numShipmentsNotInRequest: format: int32 type: integer orderID: format: int32 type: integer orderType: enum: - DIRECTSHIP - TRANSFER - STH_CONSOLIDATED - RETURN - DISPOSITION - DELIVERY - BOPIS type: string pickupLocationCode: type: string shippingAddress: $ref: '#/components/schemas/OrderRoutingShippingAddress' shippingMethod: type: string sort: enum: - SUGGESTION_SORT type: string sthConsolidationLocationOverride: type: string strategyID: type: string tags: additionalProperties: type: string type: object total: type: number required: - items - orderType - total type: object SiteService: type: object TenantService: properties: tenantAttributesCache: $ref: '#/components/schemas/TenantAttributesCache' tenantClient: $ref: '#/components/schemas/TenantClient' type: object OrderRoutingOrderItem: properties: backorderable: type: boolean condition: type: string customItemData: additionalProperties: type: object type: object extendedProductInfo: $ref: '#/components/schemas/ExtendedProductInfo' futureOrderable: type: boolean granularInventoryItem: type: boolean height: format: double type: number itemDependency: format: int32 type: integer length: format: double type: number orderItemID: format: int32 type: integer partNumber: type: string productTitle: type: string quantity: format: int32 type: integer serialNumber: type: string shippingMethod: type: string sku: type: string tags: additionalProperties: type: string type: object taxable: type: boolean upc: type: string weight: format: double type: number width: format: double type: number type: object TenantAttributesCache: type: object TenantClient: type: object securitySchemes: bearerAuth: bearerFormat: JWT description: JWT Authorization header using the Bearer scheme. scheme: bearer type: http ````