API

Logistics APIs

PUT logistics/shipping-advices/{shippingAdviceId}/items/{itemId}

Updates provided shipping advice item

HTTP method PUT
URI https://api.rambase.net/logistics/shipping-advices/{shippingAdviceId}/items/{itemId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {shippingAdviceId} Shipping advice identifier
Integer, minimum 100000
- URI parameter {itemId} Item-/line-number of the shipping advice
Integer, minimum 1
Custom fields Custom fields supported
Successful HTTP status code 202
API resource identifier 2697, version 14

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.

Format:
1
<ShippingAdviceItem
ShippingAdviceItem

This field is optional.

>
2
     <CustomersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

This field is optional.

>{String}</CustomersReferenceNumber>
3
     <Note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

This field is optional.

>{String}</Note>
4
     <RequireSerialNumberBeforeShipping
RequireSerialNumberBeforeShipping

True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.

This field is optional.

>{Boolean}</RequireSerialNumberBeforeShipping>
5
     <GrossMargin
GrossMargin

Gross margin of the item.

This field is optional.

>{Decimal}</GrossMargin>
6
     <DiscountPercent
DiscountPercent

The discount in percent for this item.

This field is optional.

>{Decimal}</DiscountPercent>
7
     <EndCustomer
EndCustomer

End customer

This field is optional.

>
8
          <CustomerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

>{Integer}</CustomerId>
9
     </EndCustomer>
10
     <Warranty
Warranty

This field is optional.

>
11
          <IsPaymentCoveredByWarranty
IsPaymentCoveredByWarranty

True if payment of item will be covered by warranty. For sales order items that are a part of the repair process, it means that these will not be invoiced.

This field is optional.

>{Boolean}</IsPaymentCoveredByWarranty>
12
     </Warranty>
13
     <Price
Price

This field is optional.

>
14
          <GrossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

This field is optional.

>{Decimal}</GrossPrice>
15
          <Discount
Discount

The discount for the item.

This field is optional.

>{Decimal}</Discount>
16
     </Price>
17
     <Seller
Seller

Reference to the seller of the item

This field is optional.

>
18
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>{Integer}</EmployeeId>
19
     </Seller>
20
     <LandedCost
LandedCost

This field is optional.

>
21
          <DerivedFrom
DerivedFrom

This field is optional.

>
22
               <PurchaseQuoteItemId
PurchaseQuoteItemId

Purchase quote item identifier

This field is optional.

>{Integer}</PurchaseQuoteItemId>
23
               <PurchaseQuote
PurchaseQuote

This field is optional.

>
24
                    <Database
Database

Database of the object. If not provided the current database will be used.

This field is optional.

>{String}</Database>
25
                    <PurchaseQuoteId
PurchaseQuoteId

Purchase quote identifier

This field is optional.

>{Integer}</PurchaseQuoteId>
26
               </PurchaseQuote>
27
          </DerivedFrom>
28
     </LandedCost>
29
     <Accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

This field is optional.

>
30
          <VATCodeDefinition
VATCodeDefinition

This field is optional.

>
31
               <VATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

>{String}</VATCode>
32
          </VATCodeDefinition>
33
     </Accounting>
34
</ShippingAdviceItem>
1
{
2
     "shippingAdviceItem
ShippingAdviceItem

This field is optional.

": {
3
          "customersReferenceNumber
CustomersReferenceNumber

Customers item reference number. Typically to the customers internal system.

This field is optional.

": "{String}",
4
          "note
Note

Additional information regarding the item (free text). Might be visible to customers/suppliers.

This field is optional.

": "{String}",
5
          "requireSerialNumberBeforeShipping
RequireSerialNumberBeforeShipping

True if serial number is required before shipping. Note that if the product has set this value to true, this can not be overridden.

This field is optional.

": "{Boolean}",
6
          "grossMargin
GrossMargin

Gross margin of the item.

This field is optional.

": "{Decimal}",
7
          "discountPercent
DiscountPercent

The discount in percent for this item.

This field is optional.

": "{Decimal}",
8
          "endCustomer
EndCustomer

End customer

This field is optional.

": {
9
               "customerId
CustomerId

Customer identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
10
          },
11
          "warranty
Warranty

This field is optional.

": {
12
               "isPaymentCoveredByWarranty
IsPaymentCoveredByWarranty

True if payment of item will be covered by warranty. For sales order items that are a part of the repair process, it means that these will not be invoiced.

This field is optional.

": "{Boolean}"
13
          },
14
          "price
Price

This field is optional.

": {
15
               "grossPrice
GrossPrice

Represents the price per unit before any discounting is applied.

This field is optional.

": "{Decimal}",
16
               "discount
Discount

The discount for the item.

This field is optional.

": "{Decimal}"
17
          },
18
          "seller
Seller

Reference to the seller of the item

This field is optional.

": {
19
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

": "{Integer}"
20
          },
21
          "landedCost
LandedCost

This field is optional.

": {
22
               "derivedFrom
DerivedFrom

This field is optional.

": {
23
                    "purchaseQuoteItemId
PurchaseQuoteItemId

Purchase quote item identifier

This field is optional.

": "{Integer}",
24
                    "purchaseQuote
PurchaseQuote

This field is optional.

": {
25
                         "database
Database

Database of the object. If not provided the current database will be used.

This field is optional.

": "{String}",
26
                         "purchaseQuoteId
PurchaseQuoteId

Purchase quote identifier

This field is optional.

": "{Integer}"
27
                    }
28
               }
29
          },
30
          "accounting
Accounting

Accounting details for the item, including fixed/system dimensions. For all dimensions, see seperate resource.

This field is optional.

": {
31
               "vATCodeDefinition
VATCodeDefinition

This field is optional.

": {
32
                    "vATCode
VATCode

Code that determines VAT rules used for VAT calculations.

This field is optional.

": "{String}"
33
               }
34
          }
35
     }
36
}

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.
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

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.

Format:
1
1

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 105170 HTTP 404 Job Sequence Extension not found
Error 100209 HTTP 400 Illegal document Id {0}
Error 105970 HTTP 400 End date is required
Error 103546 HTTP 400 Only product structures can be blocked for production
Error 107762 HTTP 400 Only product structures can auto create work orders for sub production
Error 107763 HTTP 400 Only product structures can be set up for line production
Error 107764 HTTP 400 Only product structures can be externally manufactured
Error 101517 HTTP 400 Illegal Account {0}: This account require ICTDB.
Error 102482 HTTP 400 Department is required for general ledger account {0}
Error 102483 HTTP 400 Finance project is required for general ledger account {0}
Error 102484 HTTP 400 Asset is required for general ledger account {0}
Error 102485 HTTP 400 Dimension {0} ({1}) is required for general ledger account {2}
Error 101313 HTTP 400 Department number is not valid: {0}
Error 101320 HTTP 400 The project number is not valid: {0}
Error 101500 HTTP 400 Project {0} could not be used : Check project FromPeriod and ToPeriod.
Error 101501 HTTP 400 Asset is not allowed on general ledger account {0}
Error 101326 HTTP 400 The asset number is not valid : {0}
Error 102486 HTTP 400 Invalid value for dimension {0}