Jump to

• Request
• Response

Create one association

post

/fscmRestApi/resources/11.13.18.05/carriers/{CarrierId}/child/shippingMethods/{ShipMethodCode}/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.
• ShipMethodCode(required): string
  The value that uniquely identifies the carrier shipping method, as a concatenation of carrier name, service level and mode of transport.

Header Parameters

• Metadata-Context: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"The value that uniquely identifies the inventory organization as an abbreviation. Either this attribute or OrganizationId is required.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OrganizationName"
                ]
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The value that uniquely identifies the inventory organization assigned to a carrier shipping method. Either this attribute or OrganizationCode is required.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "OrganizationCode",
                    "OrganizationName"
                ]
            }
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"The name of the inventory organization.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : carriers-shippingMethods-organizationAssociations-item-response

Type: object

Show Source

• 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.
• OrganizationCarrierServiceId: integer (int64)
  Read Only: true

  The value that uniquely identifies the carrier shipping method assigned to an organization. It is a value that the application generates when it assigns a shipping method 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCarrierServiceId":{
            "type":"integer",
            "description":"The value that uniquely identifies the carrier shipping method assigned to an organization. It is a value that the application generates when it assigns a shipping method for a carrier to an organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"The value that uniquely identifies the inventory organization as an abbreviation. Either this attribute or OrganizationId is required.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OrganizationName"
                ]
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The value that uniquely identifies the inventory organization assigned to a carrier shipping method. Either this attribute or OrganizationCode is required.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "OrganizationCode",
                    "OrganizationName"
                ]
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"The name of the inventory organization.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top