Jump to

• Request
• Response

Create one customer details for an order

post

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/shipToCustomer

Request

Path Parameters

• OrderKey(required): string
  Value that uniquely identifies the sales order. It can have the following formats.
  
  - Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
  Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".
  
  - Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
  Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.
  
  When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Address1: string
  Maximum Length: 255

  First line of the ship-to customer address.
• Address2: string
  Maximum Length: 255

  Second line of the ship-to customer address.
• Address3: string
  Maximum Length: 255

  Third line of the ship-to customer address.
• Address4: string
  Maximum Length: 255

  Fourth line of the ship-to customer address.
• AddressId: integer (int64)
  Value that uniquely identifies the ship-to customer address.
• City: string
  Maximum Length: 255

  City of the ship-to customer address.
• ContactFirstName: string
  Maximum Length: 255

  First name of the person to contact at the ship-to party site.
• ContactId: integer (int64)
  Value that uniquely identifies the contact at the ship-to party site.
• ContactLastName: string
  Maximum Length: 255

  Title name of the person to contact at the ship-to party site.
• ContactMiddleName: string
  Maximum Length: 255

  Middle name of the person to contact at the ship-to party site.
• ContactName: string
  Maximum Length: 255

  Name of the person to contact at the ship-to party site.
• ContactNameSuffix: string
  Maximum Length: 255

  Name suffix of the person to contact at the ship-to party site.
• ContactNumber: string
  Maximum Length: 255

  Telephone number of the person to contact at the ship-to party site.
• ContactTitle: string
  Maximum Length: 255

  Title of the person to contact at the ship-to party site.
• Country: string
  Maximum Length: 255

  Country of the ship-to customer address.
• County: string
  Maximum Length: 255

  County of the ship-to customer address.
• PartyId: integer (int64)
  Value that uniquely identifies the ship-to party.
• PartyName: string
  Maximum Length: 255

  Name of the ship-to party.
• PartyNumber: string
  Maximum Length: 255

  Telephone number of the ship-to party.
• PersonFirstName: string
  Maximum Length: 255

  First name of the person to contact at the ship-to customer site.
• PersonLastName: string
  Maximum Length: 255

  Last name of the person to contact at the ship-to customer site.
• PersonMiddleName: string
  Maximum Length: 255

  Middle name of the person to contact at the ship-to customer site.
• PersonNameSuffix: string
  Maximum Length: 255

  Name suffix of the person to contact at the ship-to customer site.
• PersonTitle: string
  Maximum Length: 255

  Title of the person to contact at the ship-to customer site.
• PostalCode: string
  Maximum Length: 255

  City of the ship-to customer address.
• PreferredContactPointId: integer (int64)
  Value that uniquely identifies the email for the preferred person to contact at the ship-to party site.
• Province: string
  Maximum Length: 255

  Province of the ship-to customer address.
• SiteId: integer (int64)
  Value that uniquely identifies the ship-to customer address.
• SourceAddressId: string
  Maximum Length: 255

  Value that uniquely identifies the ship-to customer address. Value is 1.
• State: string
  Maximum Length: 255

  State of the ship-to customer address.

{
    "type":"object",
    "properties":{
        "SiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to customer address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PersonNameSuffix":{
            "maxLength":"255",
            "type":"string",
            "description":"Name suffix of the person to contact at the ship-to customer site.",
            "nullable":true
        },
        "PostalCode":{
            "maxLength":"255",
            "type":"string",
            "description":"City of the ship-to customer address.",
            "nullable":true
        },
        "PartyName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the ship-to party.",
            "nullable":true
        },
        "PersonMiddleName":{
            "maxLength":"255",
            "type":"string",
            "description":"Middle name of the person to contact at the ship-to customer site.",
            "nullable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the contact at the ship-to party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "County":{
            "maxLength":"255",
            "type":"string",
            "description":"County of the ship-to customer address.",
            "nullable":true
        },
        "PersonTitle":{
            "maxLength":"255",
            "type":"string",
            "description":"Title of the person to contact at the ship-to customer site.",
            "nullable":true
        },
        "Address4":{
            "maxLength":"255",
            "type":"string",
            "description":"Fourth line of the ship-to customer address.",
            "nullable":true
        },
        "ContactNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Telephone number of the person to contact at the ship-to party site.",
            "nullable":true
        },
        "ContactFirstName":{
            "maxLength":"255",
            "type":"string",
            "description":"First name of the person to contact at the ship-to party site.",
            "nullable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to customer address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ContactMiddleName":{
            "maxLength":"255",
            "type":"string",
            "description":"Middle name of the person to contact at the ship-to party site.",
            "nullable":true
        },
        "PersonLastName":{
            "maxLength":"255",
            "type":"string",
            "description":"Last name of the person to contact at the ship-to customer site.",
            "nullable":true
        },
        "ContactNameSuffix":{
            "maxLength":"255",
            "type":"string",
            "description":"Name suffix of the person to contact at the ship-to party site.",
            "nullable":true
        },
        "Address2":{
            "maxLength":"255",
            "type":"string",
            "description":"Second line of the ship-to customer address.",
            "nullable":true
        },
        "Address3":{
            "maxLength":"255",
            "type":"string",
            "description":"Third line of the ship-to customer address.",
            "nullable":true
        },
        "PersonFirstName":{
            "maxLength":"255",
            "type":"string",
            "description":"First name of the person to contact at the ship-to customer site.",
            "nullable":true
        },
        "Address1":{
            "maxLength":"255",
            "type":"string",
            "description":"First line of the ship-to customer address.",
            "nullable":true
        },
        "City":{
            "maxLength":"255",
            "type":"string",
            "description":"City of the ship-to customer address.",
            "nullable":true
        },
        "Province":{
            "maxLength":"255",
            "type":"string",
            "description":"Province of the ship-to customer address.",
            "nullable":true
        },
        "ContactTitle":{
            "maxLength":"255",
            "type":"string",
            "description":"Title of the person to contact at the ship-to party site.",
            "nullable":true
        },
        "ContactLastName":{
            "maxLength":"255",
            "type":"string",
            "description":"Title name of the person to contact at the ship-to party site.",
            "nullable":true
        },
        "PartyNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Telephone number of the ship-to party.",
            "nullable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "State":{
            "maxLength":"255",
            "type":"string",
            "description":"State of the ship-to customer address.",
            "nullable":true
        },
        "PreferredContactPointId":{
            "type":"integer",
            "description":"Value that uniquely identifies the email for the preferred person to contact at the ship-to party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "Country":{
            "maxLength":"255",
            "type":"string",
            "description":"Country of the ship-to customer address.",
            "nullable":true
        },
        "SourceAddressId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the ship-to customer address. Value is 1.",
            "nullable":true
        },
        "ContactName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the person to contact at the ship-to party site.",
            "nullable":true
        }
    }
}

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 : salesOrdersForOrderHub-shipToCustomer-item-response

Type: object

Show Source

• Address1: string
  Maximum Length: 255

  First line of the ship-to customer address.
• Address2: string
  Maximum Length: 255

  Second line of the ship-to customer address.
• Address3: string
  Maximum Length: 255

  Third line of the ship-to customer address.
• Address4: string
  Maximum Length: 255

  Fourth line of the ship-to customer address.
• AddressId: integer (int64)
  Value that uniquely identifies the ship-to customer address.
• City: string
  Maximum Length: 255

  City of the ship-to customer address.
• ContactFirstName: string
  Maximum Length: 255

  First name of the person to contact at the ship-to party site.
• ContactId: integer (int64)
  Value that uniquely identifies the contact at the ship-to party site.
• ContactLastName: string
  Maximum Length: 255

  Title name of the person to contact at the ship-to party site.
• ContactMiddleName: string
  Maximum Length: 255

  Middle name of the person to contact at the ship-to party site.
• ContactName: string
  Maximum Length: 255

  Name of the person to contact at the ship-to party site.
• ContactNameSuffix: string
  Maximum Length: 255

  Name suffix of the person to contact at the ship-to party site.
• ContactNumber: string
  Maximum Length: 255

  Telephone number of the person to contact at the ship-to party site.
• ContactTitle: string
  Maximum Length: 255

  Title of the person to contact at the ship-to party site.
• Country: string
  Maximum Length: 255

  Country of the ship-to customer address.
• County: string
  Maximum Length: 255

  County of the ship-to customer address.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer (int64)
  Value that uniquely identifies the ship-to party.
• PartyName: string
  Maximum Length: 255

  Name of the ship-to party.
• PartyNumber: string
  Maximum Length: 255

  Telephone number of the ship-to party.
• PersonFirstName: string
  Maximum Length: 255

  First name of the person to contact at the ship-to customer site.
• PersonLastName: string
  Maximum Length: 255

  Last name of the person to contact at the ship-to customer site.
• PersonMiddleName: string
  Maximum Length: 255

  Middle name of the person to contact at the ship-to customer site.
• PersonNameSuffix: string
  Maximum Length: 255

  Name suffix of the person to contact at the ship-to customer site.
• PersonTitle: string
  Maximum Length: 255

  Title of the person to contact at the ship-to customer site.
• PostalCode: string
  Maximum Length: 255

  City of the ship-to customer address.
• PreferredContactPointId: integer (int64)
  Value that uniquely identifies the email for the preferred person to contact at the ship-to party site.
• Province: string
  Maximum Length: 255

  Province of the ship-to customer address.
• SiteId: integer (int64)
  Value that uniquely identifies the ship-to customer address.
• SourceAddressId: string
  Maximum Length: 255

  Value that uniquely identifies the ship-to customer address. Value is 1.
• State: string
  Maximum Length: 255

  State of the ship-to customer address.

{
    "type":"object",
    "properties":{
        "SiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to customer address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "maxLength":"255",
            "type":"string",
            "description":"Name suffix of the person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":"255",
            "type":"string",
            "description":"City of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the ship-to party.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "maxLength":"255",
            "type":"string",
            "description":"Middle name of the person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the contact at the ship-to party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "County":{
            "maxLength":"255",
            "type":"string",
            "description":"County of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "maxLength":"255",
            "type":"string",
            "description":"Title of the person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":"255",
            "type":"string",
            "description":"Fourth line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Telephone number of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContactFirstName":{
            "maxLength":"255",
            "type":"string",
            "description":"First name of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to customer address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ContactMiddleName":{
            "maxLength":"255",
            "type":"string",
            "description":"Middle name of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "maxLength":"255",
            "type":"string",
            "description":"Last name of the person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNameSuffix":{
            "maxLength":"255",
            "type":"string",
            "description":"Name suffix of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":"255",
            "type":"string",
            "description":"Second line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":"255",
            "type":"string",
            "description":"Third line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "maxLength":"255",
            "type":"string",
            "description":"First name of the person to contact at the ship-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":"255",
            "type":"string",
            "description":"First line of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "City":{
            "maxLength":"255",
            "type":"string",
            "description":"City of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Province":{
            "maxLength":"255",
            "type":"string",
            "description":"Province of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTitle":{
            "maxLength":"255",
            "type":"string",
            "description":"Title of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactLastName":{
            "maxLength":"255",
            "type":"string",
            "description":"Title name of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Telephone number of the ship-to party.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "State":{
            "maxLength":"255",
            "type":"string",
            "description":"State of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactPointId":{
            "type":"integer",
            "description":"Value that uniquely identifies the email for the preferred person to contact at the ship-to party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Country":{
            "maxLength":"255",
            "type":"string",
            "description":"Country of the ship-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceAddressId":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the ship-to customer address. Value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the person to contact at the ship-to party site.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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