API - Sales Shipments
This is a fork of page 30062 "APIV2 - Sales Shipments" from version 27.0.38460.40573. Added support for Extra Values.
Object Definition
| Object Type | Page |
| Object ID | 70314221 |
| Object Name | QWESR API - Sales Shipments |
| Source Table | Sales Shipment Header |
| Read-only | Yes |
API Definition
| APIPublisher | smartApps |
| APIGroup | spider |
| APIVersion | v1.0 |
| EntitySetName | salesShipments |
| EntityName | salesShipment |
Events
| Name | Description |
|---|---|
| OnGetExtraValues(Record "Sales Shipment Header"; Text; Text; Text; Text; Text; Text; Text; Text; Text; Text) | Raised after a record is read from the database. Makes it possible to set the ExtraValues 1..10, to be returned to the client. |
Example
Read
Get a list of Sales Shipments.
GET businesscentralPrefix/companies({id})/salesShipments?$schemaversion=2.0
Get a single Sales Shipment and it's lines.
GET businesscentralPrefix/companies({id})/salesShipments({id})?$expand=salesShipmentLines&$schemaversion=2.0
Controls
| Type | Name | Data Type | Read-only |
|---|---|---|---|
| Field | id | Guid | Yes |
| Field | number | Code[20] | Yes |
| Field | externalDocumentNumber | Code[35] | Yes |
| Field | invoiceDate | Date | Yes |
| Field | postingDate | Date | Yes |
| Field | dueDate | Date | Yes |
| Field | customerPurchaseOrderReference | Text[35] | Yes |
| Field | customerId | Guid | Yes |
| Field | customerNumber | Code[20] | Yes |
| Field | customerName | Text[100] | Yes |
| Field | billToCustomerId | Guid | Yes |
| Field | billToName | Text[100] | Yes |
| Field | billToCustomerNumber | Code[20] | Yes |
| Field | shipToName | Text[100] | Yes |
| Field | shipToContact | Text[100] | Yes |
| Field | sellToAddressLine1 | Text[100] | Yes |
| Field | sellToAddressLine2 | Text[50] | Yes |
| Field | sellToCity | Text[30] | Yes |
| Field | sellToCountry | Code[10] | Yes |
| Field | sellToState | Text[30] | Yes |
| Field | sellToPostCode | Code[20] | Yes |
| Field | billToAddressLine1 | Text[100] | Yes |
| Field | billToAddressLine2 | Text[50] | Yes |
| Field | billToCity | Text[30] | Yes |
| Field | billToCountry | Code[10] | Yes |
| Field | billToState | Text[30] | Yes |
| Field | billToPostCode | Code[20] | Yes |
| Field | shipToAddressLine1 | Text[100] | Yes |
| Field | shipToAddressLine2 | Text[50] | Yes |
| Field | shipToCity | Text[30] | Yes |
| Field | shipToCountry | Code[10] | Yes |
| Field | shipToState | Text[30] | Yes |
| Field | shipToPostCode | Code[20] | Yes |
| Field | currencyCode | Text | Yes |
| Field | orderNumber | Code[20] | Yes |
| Field | paymentTermsCode | Code[10] | Yes |
| Field | shipmentMethodCode | Code[10] | Yes |
| Field | salesperson | Code[20] | Yes |
| Field | pricesIncludeTax | Boolean | Yes |
| Sub page | salesShipmentLines | Yes | |
| Field | lastModifiedDateTime | DateTime | Yes |
| Field | phoneNumber | Text[30] | Yes |
| Field | Text[80] | Yes | |
| Field | extraValue1 | Text | Yes |
| Field | extraValue2 | Text | Yes |
| Field | extraValue3 | Text | Yes |
| Field | extraValue4 | Text | Yes |
| Field | extraValue5 | Text | Yes |
| Field | extraValue6 | Text | Yes |
| Field | extraValue7 | Text | Yes |
| Field | extraValue8 | Text | Yes |
| Field | extraValue9 | Text | Yes |
| Field | extraValue10 | Text | Yes |
| Sub page | dimensionSetLines | Yes |
This documentation is generated from Spider v27.2