Create location codes
post
/fscmRestApi/resources/11.13.18.05/b2bLocationCodes
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
-
Address: string
Maximum Length:
255
Address of the customer site. This value is derived. -
B2BLocationCode: string
Maximum Length:
100
Abbreviation that identifies the location code that's used to associate an address with a customer site. -
BillToFlag: boolean
Maximum Length:
20
Default Value:false
Contains one of the following values: true or false. If true, then the location is a bill to location. If false, then the location is not a bill to location. This value is derived. -
CustomerAccountSiteUseId: string
Maximum Length:
100
Value that uniquely identifies the customer account site. This value is derived. -
CustomerId: string
Maximum Length:
256
Value that uniquely identifies the customer. This value is derived. -
CustomerName: string
Name of the customer. This value is derived.
-
CustomerNumber: string
Maximum Length:
256
Number that identifies the customer. -
PartySiteId: string
Maximum Length:
100
Value that uniquely identifies the customer site. This value is derived. -
PartySiteNumber: string
Maximum Length:
30
Number that identifies the customer site. -
ShipToFlag: boolean
Maximum Length:
20
Default Value:false
Contains one of the following values: true or false. If true, then the location is a ship to location. If false, then the location is not a ship to location. This value is derived.
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 : b2bLocationCodes-item-response
Type:
Show Source
object
-
Address: string
Maximum Length:
255
Address of the customer site. This value is derived. -
B2BLocationCode: string
Maximum Length:
100
Abbreviation that identifies the location code that's used to associate an address with a customer site. -
BillToFlag: boolean
Maximum Length:
20
Default Value:false
Contains one of the following values: true or false. If true, then the location is a bill to location. If false, then the location is not a bill to location. This value is derived. -
CrossReferenceLocationValueId: integer
(int64)
Read Only:
true
Value that uniquely identifies the association of the location code to the customer site address. -
CustomerAccountSiteUseId: string
Maximum Length:
100
Value that uniquely identifies the customer account site. This value is derived. -
CustomerId: string
Maximum Length:
256
Value that uniquely identifies the customer. This value is derived. -
CustomerName: string
Name of the customer. This value is derived.
-
CustomerNumber: string
Maximum Length:
256
Number that identifies the customer. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartySiteId: string
Maximum Length:
100
Value that uniquely identifies the customer site. This value is derived. -
PartySiteNumber: string
Maximum Length:
30
Number that identifies the customer site. -
ShipToFlag: boolean
Maximum Length:
20
Default Value:false
Contains one of the following values: true or false. If true, then the location is a ship to location. If false, then the location is not a ship to location. This value is derived.
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.
Examples
This example describes how to create location codes.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/b2bLocationCodes"
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 creates.
{ "CustomerNumber":"1001", "PartySiteNumber":"1024", "B2BLocationCode":"CDRM_742060" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "CrossReferenceLocationValueId": 300100186140557, "PartySiteNumber": "1024", "CustomerNumber": "1001", "CustomerId": "1001", "B2BLocationCode": "CDRM_742060", "ShipToFlag": true, "BillToFlag": true, "PartySiteId": "1024", "CustomerAccountSiteUseId": "1006", "CustomerName": "Small, Inc.", "Address": "Example Inc., 401, Island Parkway, Redwood Shores, CA 94065", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/b2bLocationCodes/CDRM_742060", "name": "b2bLocationCodes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/b2bLocationCodes/CDRM_742060", "name": "b2bLocationCodes", "kind": "item" } ] }