Product APIs
API resource to update product structure material
| HTTP method | PUT |
| URI | https://api.rambase.net/product/structure-versions/{productStructureVersionId}/materials/{productStructureMaterialId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {productStructureVersionId} |
Product structure identifier
Integer, minimum 100000 |
| - URI parameter {productStructureMaterialId} |
Product structure material identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 7072, version 7 |
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.
ProductStructureMaterial
This field is optional.
>Quantity
Needed material/part quantity in one unit of the product.|
Minimum value: 0
This field is optional.
>{Decimal}</Quantity>Note
Note for product structure version's material
This field is optional.
>{String}</Note>PurchaseOrderNote
Purchase order note for product structure material
This field is optional.
>{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
This field is optional.
>{Boolean}</NeedsReplacementToRelease>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>ProductStructureMaterial
This field is optional.
": {Quantity
Needed material/part quantity in one unit of the product.|
Minimum value: 0
This field is optional.
": "{Decimal}",Note
Note for product structure version's material
This field is optional.
": "{String}",PurchaseOrderNote
Purchase order note for product structure material
This field is optional.
": "{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
This field is optional.
": "{Boolean}",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}"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. |
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. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
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 101699 HTTP 400 | Picking in process on item {0}. Picking of goods must be cancelled before the operation can start |
| Error 101492 HTTP 400 | Illegal VAT code: VAT value > 0 is not allowed on this document |
| Error 101493 HTTP 400 | Illegal update: New VAT code has VAT percentage different from old VAT code. |
| Error 101494 HTTP 400 | Illegal VAT code: Vat code and document has different VAT number |
| Error 101496 HTTP 400 | Illegal VAT code {0}: Check VAT FromPeriod and ToPeriod |
| Error 101495 HTTP 400 | Illegal VAT code: {0} |
| Error 107641 HTTP 400 | VAT code {0} has not an active VAT code setup |
| Error 100984 HTTP 400 | Illegal update. The General ledger posting has ST>4 |
| Error 100985 HTTP 400 | Illegal update. The General ledger posting has AGIO-calculation |
| Error 100047 HTTP 404 | Supplier not found |
| Error 101097 HTTP 404 | Given currency {0} mismatch with currencies of supplier {1} |