Jump to

• Request
• Response
• Examples

Update one customer details for an order

patch

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/lines/{linesUniqID}/child/billToCustomer/{AddressId}

Request

Path Parameters

• AddressId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• OrderKey(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• linesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines to get the hash key.

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

• AccountDescription: string
  Maximum Length: 255

  Description of the account who's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
• AccountNumber: string
  Maximum Length: 255

  Number of the customer account who's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
• Address1: string
  Maximum Length: 255

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

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

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

  Fourth line of the bill-to customer address.
• City: string
  Maximum Length: 255

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

  First name of the person to contact at the bill-to customer site.
• ContactId: integer (int64)
  Value that uniquely identifies the contact for the billing account.
• ContactLastName: string
  Maximum Length: 255

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

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

  Person to contact at the bill-to customer site.
• ContactNameSuffix: string
  Maximum Length: 255

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

  Phone number of the person to contact at the bill-to customer site.
• ContactTitle: string
  Maximum Length: 255

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

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

  County of the bill-to customer address.
• CustomerAccountId: integer (int64)
  Value that uniquely identifies the account that's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
• PartyName: string
  Maximum Length: 255

  Name of the party who's legally responsible for payment.
• PersonFirstName: string
  Maximum Length: 255

  If a person is legally responsible for payment, then this attribute contains the first name of the person.
• PersonLastName: string
  Maximum Length: 255

  If a person is legally responsible for payment, then this attribute contains the last name of the person.
• PersonMiddleName: string
  Maximum Length: 255

  If a person is legally responsible for payment, then this attribute contains the middle name of the person.
• PersonNameSuffix: string
  Maximum Length: 255

  If a person is legally responsible for payment, then this attribute contains the name suffix of the person.
• PersonTitle: string
  Maximum Length: 255

  If a person is legally responsible for payment, then this attribute contains the title of the person.
• PostalCode: string
  Maximum Length: 255

  Postal code of the bill-to customer address.
• PreferredContactPointId: integer (int64)
  Value that uniquely identifies the email for the preferred contact point for the contact at the account who's responsible for payment.
• Province: string
  Maximum Length: 255

  Province of the bill-to customer address.
• SiteUseId: integer (int64)
  Value that uniquely identifies the account site that's legally responsible for payment.
• SourceAddressId: string
  Maximum Length: 255

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

  State of the bill-to customer address.

{
    "type":"object",
    "properties":{
        "AccountDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the account who's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.",
            "nullable":true
        },
        "AccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the customer account who's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.",
            "nullable":true
        },
        "Address1":{
            "maxLength":255,
            "type":"string",
            "description":"First line of the bill-to customer address.",
            "nullable":true
        },
        "Address2":{
            "maxLength":255,
            "type":"string",
            "description":"Second line of the bill-to customer address.",
            "nullable":true
        },
        "Address3":{
            "maxLength":255,
            "type":"string",
            "description":"Third line of the bill-to customer address.",
            "nullable":true
        },
        "Address4":{
            "maxLength":255,
            "type":"string",
            "description":"Fourth line of the bill-to customer address.",
            "nullable":true
        },
        "City":{
            "maxLength":255,
            "type":"string",
            "description":"City of the bill-to customer address.",
            "nullable":true
        },
        "ContactFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"First name of the person to contact at the bill-to customer site.",
            "nullable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the contact for the billing account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ContactLastName":{
            "maxLength":255,
            "type":"string",
            "description":"Last name of the person to contact at the bill-to customer site.",
            "nullable":true
        },
        "ContactMiddleName":{
            "maxLength":255,
            "type":"string",
            "description":"Middle name of the person to contact at the bill-to customer site.",
            "nullable":true
        },
        "ContactName":{
            "maxLength":255,
            "type":"string",
            "description":"Person to contact at the bill-to customer site.",
            "nullable":true
        },
        "ContactNameSuffix":{
            "maxLength":255,
            "type":"string",
            "description":"Name suffix of the person to contact at the bill-to customer site.",
            "nullable":true
        },
        "ContactNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Phone number of the person to contact at the bill-to customer site.",
            "nullable":true
        },
        "ContactTitle":{
            "maxLength":255,
            "type":"string",
            "description":"Title of the person to contact at the bill-to customer site.",
            "nullable":true
        },
        "Country":{
            "maxLength":255,
            "type":"string",
            "description":"Country of the bill-to customer address.",
            "nullable":true
        },
        "County":{
            "maxLength":255,
            "type":"string",
            "description":"County of the bill-to customer address.",
            "nullable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the account that's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PartyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the party who's legally responsible for payment.",
            "nullable":true
        },
        "PersonFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the first name of the person.",
            "nullable":true
        },
        "PersonLastName":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the last name of the person.",
            "nullable":true
        },
        "PersonMiddleName":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the middle name of the person.",
            "nullable":true
        },
        "PersonNameSuffix":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the name suffix of the person.",
            "nullable":true
        },
        "PersonTitle":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the title of the person.",
            "nullable":true
        },
        "PostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"Postal code of the bill-to customer address.",
            "nullable":true
        },
        "PreferredContactPointId":{
            "type":"integer",
            "description":"Value that uniquely identifies the email for the preferred contact point for the contact at the account who's responsible for payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Province":{
            "maxLength":255,
            "type":"string",
            "description":"Province of the bill-to customer address.",
            "nullable":true
        },
        "SiteUseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the account site that's legally responsible for payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceAddressId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the bill-to customer address. Value is 1.",
            "nullable":true
        },
        "State":{
            "maxLength":255,
            "type":"string",
            "description":"State of the bill-to customer address.",
            "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-lines-billToCustomer-item-response

Type: object

Show Source

• AccountDescription: string
  Maximum Length: 255

  Description of the account who's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
• AccountNumber: string
  Maximum Length: 255

  Number of the customer account who's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
• Address1: string
  Maximum Length: 255

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

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

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

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

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

  First name of the person to contact at the bill-to customer site.
• ContactId: integer (int64)
  Value that uniquely identifies the contact for the billing account.
• ContactLastName: string
  Maximum Length: 255

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

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

  Person to contact at the bill-to customer site.
• ContactNameSuffix: string
  Maximum Length: 255

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

  Phone number of the person to contact at the bill-to customer site.
• ContactTitle: string
  Maximum Length: 255

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

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

  County of the bill-to customer address.
• CustomerAccountId: integer (int64)
  Value that uniquely identifies the account that's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyName: string
  Maximum Length: 255

  Name of the party who's legally responsible for payment.
• PersonFirstName: string
  Maximum Length: 255

  If a person is legally responsible for payment, then this attribute contains the first name of the person.
• PersonLastName: string
  Maximum Length: 255

  If a person is legally responsible for payment, then this attribute contains the last name of the person.
• PersonMiddleName: string
  Maximum Length: 255

  If a person is legally responsible for payment, then this attribute contains the middle name of the person.
• PersonNameSuffix: string
  Maximum Length: 255

  If a person is legally responsible for payment, then this attribute contains the name suffix of the person.
• PersonTitle: string
  Maximum Length: 255

  If a person is legally responsible for payment, then this attribute contains the title of the person.
• PostalCode: string
  Maximum Length: 255

  Postal code of the bill-to customer address.
• PreferredContactPointId: integer (int64)
  Value that uniquely identifies the email for the preferred contact point for the contact at the account who's responsible for payment.
• Province: string
  Maximum Length: 255

  Province of the bill-to customer address.
• SiteUseId: integer (int64)
  Value that uniquely identifies the account site that's legally responsible for payment.
• SourceAddressId: string
  Maximum Length: 255

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

  State of the bill-to customer address.

{
    "type":"object",
    "properties":{
        "AccountDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the account who's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the customer account who's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.",
            "nullable":true,
            "x-queryable":true
        },
        "Address1":{
            "maxLength":255,
            "type":"string",
            "description":"First line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address2":{
            "maxLength":255,
            "type":"string",
            "description":"Second line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":255,
            "type":"string",
            "description":"Third line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":255,
            "type":"string",
            "description":"Fourth line of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "AddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer address.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "City":{
            "maxLength":255,
            "type":"string",
            "description":"City of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"First name of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the contact for the billing account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactLastName":{
            "maxLength":255,
            "type":"string",
            "description":"Last name of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactMiddleName":{
            "maxLength":255,
            "type":"string",
            "description":"Middle name of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactName":{
            "maxLength":255,
            "type":"string",
            "description":"Person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNameSuffix":{
            "maxLength":255,
            "type":"string",
            "description":"Name suffix of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Phone number of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactTitle":{
            "maxLength":255,
            "type":"string",
            "description":"Title of the person to contact at the bill-to customer site.",
            "nullable":true,
            "x-queryable":true
        },
        "Country":{
            "maxLength":255,
            "type":"string",
            "description":"Country of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "County":{
            "maxLength":255,
            "type":"string",
            "description":"County of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the account that's legally responsible for payment. This account exists when a selling relationship exists between the deploying company and the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the party who's legally responsible for payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the first name of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the last name of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the middle name of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the name suffix of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "maxLength":255,
            "type":"string",
            "description":"If a person is legally responsible for payment, then this attribute contains the title of the person.",
            "nullable":true,
            "x-queryable":true
        },
        "PostalCode":{
            "maxLength":255,
            "type":"string",
            "description":"Postal code of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredContactPointId":{
            "type":"integer",
            "description":"Value that uniquely identifies the email for the preferred contact point for the contact at the account who's responsible for payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Province":{
            "maxLength":255,
            "type":"string",
            "description":"Province of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "SiteUseId":{
            "type":"integer",
            "description":"Value that uniquely identifies the account site that's legally responsible for payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceAddressId":{
            "maxLength":255,
            "type":"string",
            "description":"Value that uniquely identifies the bill-to customer address. Value is 1.",
            "nullable":true,
            "x-queryable":true
        },
        "State":{
            "maxLength":255,
            "type":"string",
            "description":"State of the bill-to customer address.",
            "nullable":true,
            "x-queryable":true
        },
        "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

Examples

This example describes how to update one customer detail for an order.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/OrderKey/child/lines/linesUniqID/child/billToCustomer/AddressId"

For example, use the following command:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_Std_Item_02/child/lines/00020000000EACED00057708000110F084F87ACF0000000EACED00057708000110F084F87AD0/child/billToCustomer/300100185782991"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

You can achieve the same result with Create sales orders using the upsert-mode header parameter. Refer to the examples in the Create sales orders section to see how to update child resource in the existing order.

{
	"PartyName":"Computer Service and Rentals",
	"AccountNumber":"1006",
	"Address1":"301 Summit Hill Drive",
	"City":"CHATTANOOGA",
	"State":"TN",
	"PostalCode":"37401",
	"County":"Hamilton",
	"Province":null,
	"Country":"US",
	"ContactName":"Evelyn Jones",
	"ContactFirstName":"Evelyn",
	"ContactLastName":"Jones",
	"SourceAddressId":1
}	

Example Response Body

The following example includes the contents of the response body in JSON format:

{}

Back to Top