Procurement APIs
Details of provided change in purchase order change request
| HTTP method | GET |
| URI | https://api.rambase.net/procurement/change-requests/{purchaseOrderChangeRequestId}/changes/{changeId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {purchaseOrderChangeRequestId} |
Purchase order change request identifier
Integer, minimum 100000 |
| - URI parameter {changeId} |
Change identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 3089, version 18 |
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.
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.
| $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] |
| $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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select 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.
ChangeId
Change identifier
>{Integer}</ChangeId>Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
>{String}</Note>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
>{String}</SuppliersReferenceNumber>HasItems
True if this change has one or more items. The items describes the requested changes to current item, and if no items has been added, the change will not be sent to supplier.
>{Boolean}</HasItems>CurrentQuantity
The remaining quantity of the purchase order or purchase order response item at the time this change request was created.
>{Decimal}</CurrentQuantity>CancelledQuantity
The total cancelled quantity in this purchase order change request. Cannot be higher than the current quantity.
>{Decimal}</CancelledQuantity>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
>{Integer}</LineNumber>RequestedDeliveryDate
The delivery date as requested by the buyer/purchaser
>{Date}</RequestedDeliveryDate>ConfirmedDeliveryDate
Confirmed delivery date
>{Date}</ConfirmedDeliveryDate>SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
>{String}</SuppliersReferenceNumber>SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
>{String}</SuppliersProductName>EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
>{String}</EquivalentProductName>ProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
>{String}</ProductStructureRevision>ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
>{String}</ProductDescription>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>NetPrice
Final price per unit after deducting all discounts etc.
>{Decimal}</NetPrice>ProductId
Product identifier
>{Integer}</ProductId>Name
Name of the product
>{String}</Name>ProductLink
Product reference
>{String}</ProductLink>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>ItemLink
API reference to the item
>{String}</ItemLink>PurchaseOrderItemId
Item-/line-number of the purchase order
>{Integer}</PurchaseOrderItemId>PurchaseOrderId
Purchase order identifier
>{Integer}</PurchaseOrderId>PurchaseOrderLink
Purchase order reference
>{String}</PurchaseOrderLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>PurchaseOrderItemLink
Purchase order item reference
>{String}</PurchaseOrderItemLink>PurchaseOrderResponseId
Purchase order response identifier
>{Integer}</PurchaseOrderResponseId>PurchaseOrderResponseLink
Purchase order response reference
>{String}</PurchaseOrderResponseLink>ChangeId
Change identifier
": "{Integer}",Status
Status of the change
Possible domain values can be found here
": "{Integer}",Note
Additional information regarding the item (free text). Might be visible to customers/suppliers.
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
": "{String}",HasItems
True if this change has one or more items. The items describes the requested changes to current item, and if no items has been added, the change will not be sent to supplier.
": "{Boolean}",CurrentQuantity
The remaining quantity of the purchase order or purchase order response item at the time this change request was created.
": "{Decimal}",CancelledQuantity
The total cancelled quantity in this purchase order change request. Cannot be higher than the current quantity.
": "{Decimal}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",LineNumber
Line- or sequence number of the item. The LineNumber is used for sorting items in applications, prints, reports etc.
": "{Integer}",RequestedDeliveryDate
The delivery date as requested by the buyer/purchaser
": "{Date}",ConfirmedDeliveryDate
Confirmed delivery date
": "{Date}",SuppliersReferenceNumber
Suppliers/sellers item reference number. Typically to an external system.
": "{String}",SuppliersProductName
Suppliers internal name of the product. Retrieved from the product.
": "{String}",EquivalentProductName
Name of product with equivalent behavior and attributes. Can be used for same purpose.
": "{String}",ProductStructureRevision
The revision will typically be a major change, as opposed to minor changes stored in the version of the product structure.
": "{String}",ProductDescription
Description of the item. If not specified, the description is by default copied from the product.
": "{String}",Currency
Three character code following the ISO 4217 standard
": "{String}",NetPrice
Final price per unit after deducting all discounts etc.
": "{Decimal}"ProductId
Product identifier
": "{Integer}",Name
Name of the product
": "{String}",Type
Type of product
Possible domain values can be found here
": "{String}",ProductLink
Product reference
": "{String}"ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}"RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",ItemLink
API reference to the item
": "{String}"PurchaseOrderItemId
Item-/line-number of the purchase order
": "{Integer}",PurchaseOrderId
Purchase order identifier
": "{Integer}",PurchaseOrderLink
Purchase order reference
": "{String}"RamBaseKey
Internal RamBase identifier of the object/item
": "{String}",PurchaseOrderItemLink
Purchase order item reference
": "{String}"PurchaseOrderResponseId
Purchase order response identifier
": "{Integer}",PurchaseOrderResponseLink
Purchase order response 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 102738 HTTP 404 | Price list not found |
| Error 100055 HTTP 403 | You have only admittance to your own objects |
| Error 101233 HTTP 404 | Purchase order response item not found. |