Create a pack
post
/fscmRestApi/resources/11.13.18.05/supplierProducts/{supplierProductsUniqID}/child/packs
Request
Path Parameters
-
supplierProductsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Supplier Products resource and used to uniquely identify an instance of Supplier Products. The client should not generate the hash key value. Instead, the client should query on the Supplier Products collection resource in order to navigate to a specific instance of Supplier Products to get the hash key.
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
-
CommonItemNumber: string
Maximum Length:
240
Name or number of the item for a common pack. -
CommonOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization for a common pack. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. -
CommonOrganizationId: integer
(int64)
Value that uniquely identifies the organization for a common pack. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
-
ItemNumber: string
Maximum Length:
820
Name or number of the part, item, product, or service. -
ItemTransactionId: integer
(int64)
Value that identifies the product row in staging.
-
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
-
packComponents: array
Pack Components
Title:
Pack Components
The Pack Components resource is used to manage pack components of supplier products. -
ProductNumber: string
Maximum Length:
255
Name or number of the spoke part, item, product, or service. -
SpokeSystemCode: string
Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
-
SpokeSystemId: integer
(int64)
Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
-
SupplierId: integer
(int64)
Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
-
SupplierName: string
Title:
Supplier
Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task. -
TransactionId: integer
(int64)
Value that uniquely identifies the pack row in staging.
Nested Schema : Pack Components
Type:
array
Title:
Pack Components
The Pack Components resource is used to manage pack components of supplier products.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AssemblyItemNumber: string
Maximum Length:
820
Number that identifies the parent item of the component item of a pack. -
ComponentItemNumber: string
Maximum Length:
820
Number that identifies the component item of a pack. -
ComponentProductDescription: string
Title:
Component Product Description
Maximum Length:240
Spoke item description of the component item of a pack. -
ComponentProductNumber: string
Title:
Component Product Number
Maximum Length:255
Spoke item number of the component item of a pack. -
ComponentQuantity: number
Quantity of the component item used in the pack.
-
ItemTransactionId: integer
(int64)
Value that identifies the product row in staging.
-
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
-
ParentProductNumber: string
Title:
Parent Product Number
Maximum Length:255
Spoke item number of the parent item of the component item of a pack. -
SpokeSystemCode: string
Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
-
SpokeSystemId: integer
(int64)
Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
-
SupplierId: integer
(int64)
Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
-
SupplierName: string
Title:
Supplier
Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task. -
TransactionId: integer
Value that uniquely identifies the pack component row in staging.
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 : supplierProducts-packs-item-response
Type:
Show Source
object
-
CommonItemNumber: string
Maximum Length:
240
Name or number of the item for a common pack. -
CommonOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization for a common pack. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. -
CommonOrganizationId: integer
(int64)
Value that uniquely identifies the organization for a common pack. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the pack. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the application created the pack. -
ItemNumber: string
Maximum Length:
820
Name or number of the part, item, product, or service. -
ItemTransactionId: integer
(int64)
Value that identifies the product row in staging.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the pack was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the pack. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
-
packComponents: array
Pack Components
Title:
Pack Components
The Pack Components resource is used to manage pack components of supplier products. -
ProductNumber: string
Maximum Length:
255
Name or number of the spoke part, item, product, or service. -
SpokeSystemCode: string
Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
-
SpokeSystemId: integer
(int64)
Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
-
SupplierId: integer
(int64)
Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
-
SupplierName: string
Title:
Supplier
Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task. -
TransactionId: integer
(int64)
Value that uniquely identifies the pack row in staging.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Pack Components
Type:
array
Title:
Pack Components
The Pack Components resource is used to manage pack components of supplier products.
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.
Nested Schema : supplierProducts-packs-packComponents-item-response
Type:
Show Source
object
-
AssemblyItemNumber: string
Maximum Length:
820
Number that identifies the parent item of the component item of a pack. -
ComponentItemNumber: string
Maximum Length:
820
Number that identifies the component item of a pack. -
ComponentProductDescription: string
Title:
Component Product Description
Maximum Length:240
Spoke item description of the component item of a pack. -
ComponentProductNumber: string
Title:
Component Product Number
Maximum Length:255
Spoke item number of the component item of a pack. -
ComponentQuantity: number
Quantity of the component item used in the pack.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the pack component. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the application created the pack component. -
ItemTransactionId: integer
(int64)
Value that identifies the product row in staging.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the pack component was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the pack component. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Inventory Organizations task.
-
ParentProductNumber: string
Title:
Parent Product Number
Maximum Length:255
Spoke item number of the parent item of the component item of a pack. -
SpokeSystemCode: string
Abbreviation that identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
-
SpokeSystemId: integer
(int64)
Value that uniquely identifies the spoke system. Review and update the value for this attribute using the Product Information Management work area, and the Manage Spoke Systems task.
-
SupplierId: integer
(int64)
Value that uniquely identifies the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task.
-
SupplierName: string
Title:
Supplier
Name of the supplier. Review and update the value for this attribute using the Supplier Portal work area, and the Manage Suppliers task. -
TransactionId: integer
Value that uniquely identifies the pack component row in staging.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- packComponents
-
Parameters:
- TransactionId:
$request.path.TransactionId
- supplierProductsUniqID:
$request.path.supplierProductsUniqID
The Pack Components resource is used to manage pack components of supplier products. - TransactionId: