salesShipment resource type

Represents a sales shipment in Business Central.

Note

For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Methods

MethodReturn TypeDescription
GET salesShipmentsalesShipmentGets a sales shipment object.
NavigationReturn TypeDescription
customercustomerGets the customer of the salesShipment.
salesShipmentLinessalesShipmentLinesGets the salesshipmentlines of the salesShipment.
dimensionSetLinesdimensionSetLinesGets the dimensionsetlines of the salesShipment.

Properties

PropertyTypeDescription
idGUIDThe unique ID of the sales shipment. Non-editable.
numberstringSpecifies the number of the sales shipment.
externalDocumentNumberstringSpecifies an external document number for the sales shipment.
invoiceDatedateThe invoice date .
postingDatedateThe date that the sales shipment is posted.
dueDatedateThe date the sales shipment is due.
customerPurchaseOrderReferencestringThe customer purchase order reference for the invoice.
customerIdGUIDThe unique ID of customer.
customerNumberstringThe customer's number.
customerNamestringThe customer's name.
billToCustomerIdGUIDBill to customer id.
billToNamestringBill to name.
billToCustomerNumberstringBill to customer number.
shipToNamestringShip to name.
shipToContactstringShip to contact.
sellToAddressLine1stringSell to address line 1.
sellToAddressLine2stringSell to address line 2.
sellToCitystringSell to city.
sellToCountrystringSell to country.
sellToStatestringSell to state.
sellToPostCodestringSell to post code.
billToAddressLine1stringBill to address line 1.
billToAddressLine2stringBill to address line 2.
billToCitystringBill to city.
billToCountrystringBill to country.
billToStatestringBill to state.
billToPostCodestringBill to post code.
shipToAddressLine1stringShip to address line 1.
shipToAddressLine2stringShip to address line 2.
shipToCitystringShip to city.
shipToCountrystringShip to country.
shipToStatestringShip to state.
shipToPostCodestringShip to post code.
currencyCodestringThe default currency code for the sales shipment.
orderNumberstringThe number of the order to which the sales shipment is associated to. Read-Only.
paymentTermsCodestringSpecifies the code of the payment term that the sales shipment uses.
shipmentMethodCodestringSpecifies the code of the shipment method that sales shipment uses.
salespersonstringThe salesperson code for the sales shipment.
pricesIncludeTaxbooleanSpecifies whether the prices include Tax or not. Read-Only.
lastModifiedDateTimedatetimeThe last datetime the sales shipment was modified. Read-Only.
phoneNumberstringSpecifies the sales shipment's telephone number.
emailstringSpecifies the sales shipment's email address.

JSON representation

Here's a JSON representation of the salesShipment resource.

{
    "id": "GUID",
    "number": "string",
    "externalDocumentNumber": "string",
    "invoiceDate": "date",
    "postingDate": "date",
    "dueDate": "date",
    "customerPurchaseOrderReference": "string",
    "customerId": "GUID",
    "customerNumber": "string",
    "customerName": "string",
    "billToCustomerId": "GUID",
    "billToName": "string",
    "billToCustomerNumber": "string",
    "shipToName": "string",
    "shipToContact": "string",
    "sellToAddressLine1": "string",
    "sellToAddressLine2": "string",
    "sellToCity": "string",
    "sellToCountry": "string",
    "sellToState": "string",
    "sellToPostCode": "string",
    "billToAddressLine1": "string",
    "billToAddressLine2": "string",
    "billToCity": "string",
    "billToCountry": "string",
    "billToState": "string",
    "billToPostCode": "string",
    "shipToAddressLine1": "string",
    "shipToAddressLine2": "string",
    "shipToCity": "string",
    "shipToCountry": "string",
    "shipToState": "string",
    "shipToPostCode": "string",
    "currencyCode": "string",
    "orderNumber": "string",
    "paymentTermsCode": "string",
    "shipmentMethodCode": "string",
    "salesperson": "string",
    "pricesIncludeTax": "boolean",
    "lastModifiedDateTime": "datetime",
    "phoneNumber": "string",
    "email": "string"
}

GET salesShipment