Create ship-to assignments
/fscmRestApi/resources/11.13.18.05/b2bAccountNumbers/{AccountNumberId}/child/shipToAssignments
Request
-
AccountNumberId(required): integer(int64)
Unique identifier of the B2B account number. This value is derived.
-
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.
- application/json
object
-
AccountNumberId: integer
(int64)
Unique identifier of the B2B account number. This is a foreign key to the cmk account numbers table.
-
Address: string
Maximum Length:
255
Address of the ship-to location. -
Set: string
Maximum Length:
255
Code of the set to which the location belongs, for example, common set. -
ShipToAssignmentId: integer
(int64)
Unique identifier for the Ship to Location Assignment. Its value is an application-generated unique ID.
-
ShipToLocationCode: string
Maximum Length:
255
Ship-to location code. This is a required field. -
ShipToLocationId: integer
(int64)
Unique identifier of the ship-to location. This value is derived.
Response
- application/json
Default Response
-
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.
object
-
AccountNumberId: integer
(int64)
Unique identifier of the B2B account number. This is a foreign key to the cmk account numbers table.
-
Address: string
Maximum Length:
255
Address of the ship-to location. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Set: string
Maximum Length:
255
Code of the set to which the location belongs, for example, common set. -
ShipToAssignmentId: integer
(int64)
Unique identifier for the Ship to Location Assignment. Its value is an application-generated unique ID.
-
ShipToLocationCode: string
Maximum Length:
255
Ship-to location code. This is a required field. -
ShipToLocationId: integer
(int64)
Unique identifier of the ship-to location. This value is derived.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
These examples describe how to create ship-to assignments.
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/b2bAccountNumbers/AccountNumberId/child/shipToAssignments"
Example 1 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.
{ "ShipToLocationCode": "CRFL RRF LOC US1" }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "AccountNumberId": 300100618127965, "ShipToAssignmentId": 300100644904765, "ShipToLocationId": 300100067713963, "ShipToLocationCode": "CRFL RRF LOC US1", "Set": "Common Set", "Address": "1000 Oracle Place, PLEASANTON,CA 94566, ALAMEDA, United States" }
Example 2 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.
{ "parts": [ { "id": "part1", "path": "/b2bAccountNumbers/300100644904773/child/shipToAssignments", "operation": "create", "payload": { "ShipToLocationCode": "CSP10000" } }, { "id": "part2", "path": "/b2bAccountNumbers/300100644904773/child/shipToAssignments", "operation": "create", "payload": { "ShipToLocationCode": "CSP10002" } } ] }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "parts": [ { "id": "part1", "path": "https://servername/fscmRestApi/resources/version/b2bAccountNumbers/300100644904773/child/shipToAssignments", "operation": "create", "payload": { "AccountNumberId": 300100644904773, "ShipToAssignmentId": 300100644903180, "ShipToLocationId": 3244, "ShipToLocationCode": "CSP10000", "Set": "Common Set", "Address": "393 Bramble Ct, Foster City,CA 94404, San Mateo, United States" } }, { . . . } ] }