API

Sales APIs

Description

The sales order object is one of the most cruical objects in the RamBase sales process. The object can be created directly, or might be a result of a sales order request or a sales quote. The sales order is issued by the company to a customer, and authorizes sale of the spcified item(s).

Tags and resources

GET
logistics/serial-number-specifications
List of all serial numbers registered in items of: Sales Orders, Shipping Advices, Purchase Orders, Goods Receptions
POST
sales/orders
Resource for creating new sales orders. Note that only customer is required.
GET
sales/orders
List of sales orders
GET
sales/orders/{salesOrderId}
Sales order details for the provided identifier
POST
sales/orders/{salesOrderId}/api-operations/{apiOperationId}/instances
50 operation(s) for sales/orders/{salesOrderId}
PUT
sales/orders/{salesOrderId}
Saves information about the sales order
DELETE
sales/orders/{salesOrderId}
Deletes a sales order
GET
sales/orders/{salesOrderId}/applicable-accessories?productId={productId}&itemId={itemId}
List of applicable accessories for all items of the sales order. If the sales order is in a status where items cannot be added, this API will return an empty list. Note that if product is specified, applicable accessories for that specific product will show even if the product does not exist in any of the items.
GET
sales/orders/{salesOrderId}/applicable-replacements?productId={productId}&itemId={itemId}
List of applicable replacements for all items of the sales order. If the sales order is in a status where items cannot be added, this API will return an empty list. Note that if product is specified, applicable replacements for that specific product will show even if the product does not exist in any of the items.
GET
sales/orders/{salesOrderId}/assignments
List of assignments linked with provided sales order
POST
sales/orders/{salesOrderId}/assignments/api-operations/{apiOperationId}/instances
2 operation(s) for sales/orders/{salesOrderId}/assignments
GET
sales/orders/{salesOrderId}/forward-destinations?objectType={objectType}
List of possible targets to forward sales order to
GET
sales/orders/{salesOrderId}/payment-items
List of all payment items for provided sales order
GET
sales/orders/key-figures?groupBy={groupBy}
Key figures for sales orders.