Create one association
post
/fscmRestApi/resources/11.13.18.05/carriers/{CarrierId}/child/inboundTrackingRules/{TrackingRuleName}/child/organizationAssociations
Request
Path Parameters
-
CarrierId(required): integer(int64)
The value that uniquely identifies the carrier. It is a primary key that the application generates when it creates a carrier.
-
TrackingRuleName(required): string
The name of the tracking rule. This attribute is required.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
OrganizationCode: string
Maximum Length:
18
The value that uniquely identifies the inventory organization as an abbreviation. Either this attribute or OrganizationId is required. -
OrganizationId: integer
(int64)
The value that uniquely identifies the inventory organization assigned to a carrier shipping method. Either this attribute or OrganizationCode is required.
-
OrganizationName: string
Maximum Length:
240
The name of the inventory organization.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : carriers-inboundTrackingRules-organizationAssociations-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCarrierTrackingId: integer
(int64)
Read Only:
true
The value that uniquely identifies the tracking rule assigned to an organization. It is a value that the application generates when it assigns a tracking rule for a carrier to an organization. -
OrganizationCode: string
Maximum Length:
18
The value that uniquely identifies the inventory organization as an abbreviation. Either this attribute or OrganizationId is required. -
OrganizationId: integer
(int64)
The value that uniquely identifies the inventory organization assigned to a carrier shipping method. Either this attribute or OrganizationCode is required.
-
OrganizationName: string
Maximum Length:
240
The name of the inventory organization.
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.