Product APIs
API resource to append a new product structure material
| HTTP method | POST |
| URI | https://api.rambase.net/product/structure-versions/{productStructureVersionId}/materials |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productStructureVersionId} |
Product structure identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 7070, version 6 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
Quantity
Required/mandatory field
Needed material/part quantity in one unit of the product.|
Minimum value: 0
>{Decimal}</Quantity>Note
Note for product structure version's material
This field is optional.
>{String}</Note>WastagePercent
Standard percentage of wastage for material when used in a production work order
Minimum value: 0
This field is optional.
>{Decimal}</WastagePercent>WastageQuantity
Standard quantity of wastage for material when used in a production work order
Minimum value: 0
This field is optional.
>{Decimal}</WastageQuantity>CustomersReferenceNumber
A customer's reference number for product structure material
This field is optional.
>{String}</CustomersReferenceNumber>PlacementInstructionNote
A product structure material's placement in the assembly
This field is optional.
>{String}</PlacementInstructionNote>ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
>{Integer}</ProductId>ProductStructureOperation
This field is optional.
>SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
Minimum value: 1
This field is optional.
>{Integer}</SequenceNumber>Quantity
Required/mandatory field
Needed material/part quantity in one unit of the product.|
Minimum value: 0
": "{Decimal}",Note
Note for product structure version's material
This field is optional.
": "{String}",WastagePercent
Standard percentage of wastage for material when used in a production work order
Minimum value: 0
This field is optional.
": "{Decimal}",WastageQuantity
Standard quantity of wastage for material when used in a production work order
Minimum value: 0
This field is optional.
": "{Decimal}",CustomersReferenceNumber
A customer's reference number for product structure material
This field is optional.
": "{String}",PlacementInstructionNote
A product structure material's placement in the assembly
This field is optional.
": "{String}",ProductId
Required/mandatory field
Product identifier
Minimum value: 10000
": "{Integer}"ProductStructureOperation
This field is optional.
": {SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
Minimum value: 1
This field is optional.
": "{Integer}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
ProductStructureMaterialId
Product structure material identifier
>{Integer}</ProductStructureMaterialId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Quantity
Needed material/part quantity in one unit of the product.|
>{Decimal}</Quantity>Note
Note for product structure version's material
>{String}</Note>PurchaseOrderNote
Purchase order note for product structure material
>{String}</PurchaseOrderNote>NeedsReplacementToRelease
A flag to tell if this is a product which needs to be replaced in the production work order structure before releasing the production
>{Boolean}</NeedsReplacementToRelease>WastagePercent
Standard percentage of wastage for material when used in a production work order
>{Decimal}</WastagePercent>WastageQuantity
Standard quantity of wastage for material when used in a production work order
>{Decimal}</WastageQuantity>CustomersReferenceNumber
A customer's reference number for product structure material
>{String}</CustomersReferenceNumber>PlacementInstructionNote
A product structure material's placement in the assembly
>{String}</PlacementInstructionNote>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>MeasurementUnit
Measurement unit used for this product, both in sales and purchase.
>MeasurementUnitId
Measurement unit identifier
>{Integer}</MeasurementUnitId>Unit
Measurement unit (ex. mm, km, dl, kg)
>{String}</Unit>MeasurementUnitLink
Material unit reference
>{String}</MeasurementUnitLink>ProductLink
Product reference
>{String}</ProductLink>ProductId
Product identifier
>{Integer}</ProductId>ProductLink
Product reference
>{String}</ProductLink>ProductStructureOperationId
Product structure operation identifier
>{Integer}</ProductStructureOperationId>SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
>{Integer}</SequenceNumber>ProductionOperationId
Production operation identifier
>{Integer}</ProductionOperationId>Name
Name of production operation
>{String}</Name>ProductionOperationLink
Production operation reference
>{String}</ProductionOperationLink>ProductStructureOperationLink
Product structure operation reference
>{String}</ProductStructureOperationLink>ProductStructureVersionId
Product structure identifier
>{Integer}</ProductStructureVersionId>TaskId
Unique task identifier
>{Integer}</TaskId>Title
The title/summary of the task
>{String}</Title>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Priority
The priority of the task.
Possible domain values can be found here
>{Integer}</Priority>TaskLink
Task reference
>{String}</TaskLink>ProductStructureMaterialId
Product structure material identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Quantity
Needed material/part quantity in one unit of the product.|
": "{Decimal}",Note
Note for product structure version's material
": "{String}",PurchaseOrderNote
Purchase order note for product structure material
": "{String}",NeedsReplacementToRelease
A flag to tell if this is a product which needs to be replaced in the production work order structure before releasing the production
": "{Boolean}",WastagePercent
Standard percentage of wastage for material when used in a production work order
": "{Decimal}",WastageQuantity
Standard quantity of wastage for material when used in a production work order
": "{Decimal}",CustomersReferenceNumber
A customer's reference number for product structure material
": "{String}",PlacementInstructionNote
A product structure material's placement in the assembly
": "{String}",ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",MeasurementUnit
Measurement unit used for this product, both in sales and purchase.
": {MeasurementUnitId
Measurement unit identifier
": "{Integer}",Unit
Measurement unit (ex. mm, km, dl, kg)
": "{String}",MeasurementUnitLink
Material unit reference
": "{String}"ProductLink
Product reference
": "{String}"ProductId
Product identifier
": "{Integer}",ProductLink
Product reference
": "{String}"ProductStructureOperationId
Product structure operation identifier
": "{Integer}",SequenceNumber
Sequence number of the product structure operation. Unique within a product structure.
": "{Integer}",ProductionOperationId
Production operation identifier
": "{Integer}",Name
Name of production operation
": "{String}",ProductionOperationLink
Production operation reference
": "{String}"ProductStructureOperationLink
Product structure operation reference
": "{String}"ProductStructureVersionId
Product structure identifier
": "{Integer}",TaskId
Unique task identifier
": "{Integer}",Type
The type of the task
Possible domain values can be found here
": "{String}",Title
The title/summary of the task
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",Status
The status of a task
Possible domain values can be found here
": "{Integer}",Priority
The priority of the task.
Possible domain values can be found here
": "{Integer}",TaskLink
Task reference
": "{String}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 106110 HTTP 400 | External work items (type WX) are not allowed |
| Error 107056 HTTP 400 | Products meant for project orders are not allowed in this document |
| Error 104306 HTTP 400 | Manufacturers product is not connected to this product |
| Error 104311 HTTP 400 | Manufacturers product is no longer valid to use |
| Error 101118 HTTP 400 | Seller is not valid |
| Error 100199 HTTP 404 | Location is not found |
| Error 106493 HTTP 400 | Currencies of document and recurring price should always match |
| Error 105820 HTTP 400 | Expected end date should come after start date |
| Error 105784 HTTP 400 | Only subscription products can be added to subscription items |
| Error 106957 HTTP 400 | Only rental or subscription products can be used in recurring contract's lines |
| Error 105760 HTTP 400 | You cannot attach a recurring price to a sales order item |
| Error 106302 HTTP 404 | Product revision not found |
| Error 100047 HTTP 404 | Supplier not found |
| Error 101097 HTTP 404 | Given currency {0} mismatch with currencies of supplier {1} |