Create rules
post
/fscmRestApi/resources/11.13.18.05/returnRoutingRules
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CategoryId: integer
(int64)
Value that uniquely identifies the item category.
-
CategoryName: string
Maximum Length:
250
Abbreviation that identifies the item category. -
CategorySetId: integer
(int64)
Value that uniquely identifies the item catalog.
-
CategorySetName: string
Maximum Length:
30
Abbreviation that identifies the item catalog. -
DestinationOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the destination organization. -
DestinationOrganizationId: integer
(int64)
Value that uniquely identifies the destination organization.
-
DestinationSubinventory: string
Maximum Length:
10
Name of destination subinventory. -
EnabledFlag: boolean
Maximum Length:
1
Status of the return routing rule. -
GeographyId: integer
(int64)
Value that uniquely identifies the zone of the customer's address.
-
GeographyName: string
Maximum Length:
360
Abbreviation that identifies the zone of the customer's address. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item being returned.
-
InventoryItemNumber: string
Maximum Length:
300
Number that identifies the inventory item being returned. -
ReturnType: string
Maximum Length:
10
Type of return of return routing rule. Valid values include Defective or Excess. -
RuleId: integer
(int64)
Value that uniquely identifies the return routing rule.
-
SourceOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the source organization. -
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the source organization.
-
SourceSubinventory: string
Maximum Length:
10
Name of source subinventory. -
SourceType: string
Maximum Length:
3
Type of source of the return routing rule. Valid values include Zone or Warehouse.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : returnRoutingRules-item-response
Type:
Show Source
object
-
CategoryId: integer
(int64)
Value that uniquely identifies the item category.
-
CategoryName: string
Maximum Length:
250
Abbreviation that identifies the item category. -
CategorySetId: integer
(int64)
Value that uniquely identifies the item catalog.
-
CategorySetName: string
Maximum Length:
30
Abbreviation that identifies the item catalog. -
DestinationOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the destination organization. -
DestinationOrganizationId: integer
(int64)
Value that uniquely identifies the destination organization.
-
DestinationOrganizationName: string
Read Only:
true
Maximum Length:240
Name of the destination organization. -
DestinationSubinventory: string
Maximum Length:
10
Name of destination subinventory. -
EnabledFlag: boolean
Maximum Length:
1
Status of the return routing rule. -
GeographyId: integer
(int64)
Value that uniquely identifies the zone of the customer's address.
-
GeographyName: string
Maximum Length:
360
Abbreviation that identifies the zone of the customer's address. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item being returned.
-
InventoryItemNumber: string
Maximum Length:
300
Number that identifies the inventory item being returned. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReturnType: string
Maximum Length:
10
Type of return of return routing rule. Valid values include Defective or Excess. -
RuleId: integer
(int64)
Value that uniquely identifies the return routing rule.
-
SourceOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the source organization. -
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the source organization.
-
SourceOrganizationName: string
Read Only:
true
Maximum Length:240
Name of the source organization. -
SourceSubinventory: string
Maximum Length:
10
Name of source subinventory. -
SourceType: string
Maximum Length:
3
Type of source of the return routing rule. Valid values include Zone or Warehouse.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.