Shipping | Shipping Request
Service to manage entities of type 'ShippingRequest'.
Overview
| URL | api/{tenantKey}/{orgKey}/shipping/shippingRequests |
| Methods Supported | GET |
All Operations
This service includes the following operations:
-
GET:
- GET ShippingRequests
- GET ShippingRequests (paged)
- GET ShippingRequest by identifier
- GET ShippingRequest by key
- GET Print ShippingRequest by identifier
- GET Print ShippingRequest by key
- GET Original Print ShippingRequestOriginal by identifier
- GET Original Print ShippingRequest by key
- GET Get Delayed Requests
- GET Get Partial Requests
- GET Get Today Requests
All Resources
This service uses the following resources:
- MainResResource
- MainResShippingRequestLinesResource
- ShippingRequestLineResource
- ShippingRequestResource
All Enumerations
This service uses the following enumerations:
GET ShippingRequests
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See ShippingRequestResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/shipping/shippingRequests
GET /shipping/shippingRequests
GET ShippingRequests (paged)
Returns a page of the list of all the entity records available.
The following elements are optional:
| page | (int) The index of the page of the list that should be returned. This is a query string parameter. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter. |
Response:
| When successful, the response body contains the list of records available. See ShippingRequestResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/shipping/shippingRequests?page={page}&pageSize={pageSize}
GET /shipping/shippingRequests?page={page}&pageSize={pageSize}
GET ShippingRequest by identifier
Returns the entity record that matches the specified identifier.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See ShippingRequestResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/shipping/shippingRequests/{id}
GET /shipping/shippingRequests/{id}
GET ShippingRequest by key
Returns the entity record that matches the specified key.
The following elements are required:
| companyKey | (string) The company key. |
| shippingRequestKey | (int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key. |
Response:
| When successful, the response body contains the entity record. See ShippingRequestResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/shipping/shippingRequests/{companyKey}/{shippingRequestKey}
GET /shipping/shippingRequests/{companyKey}/{shippingRequestKey}
GET Print ShippingRequest by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/shipping/shippingRequests/{id}/print?template={template}
GET /shipping/shippingRequests/{id}/print?template={template}
GET Print ShippingRequest by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| shippingRequestKey | (int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/shipping/shippingRequests/{companyKey}/{shippingRequestKey}/print
GET /shipping/shippingRequests/{companyKey}/{shippingRequestKey}/print
GET Original Print ShippingRequestOriginal by identifier
Prints the specified entity record.
The following elements are required:
| id | (string) The record identifier. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 404 | NotFound. The specified resord does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/shipping/shippingRequests/{id}/printOriginal?template={template}
GET /shipping/shippingRequests/{id}/printOriginal?template={template}
GET Original Print ShippingRequest by key
Prints the specified entity record.
The following elements are required:
| companyKey | (string) The company key. |
| shippingRequestKey | (int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key. |
The following elements are optional:
| template | (string) The report template that should be used. This is a query string parameter. |
Response:
| When successful, the response body contains a stream with the printed file. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
| 404 | NotFound. The specified record does not exist. |
Resource URL:
api/{tenantKey}/{orgKey}/shipping/shippingRequests/{companyKey}/{shippingRequestKey}/printOriginal
GET /shipping/shippingRequests/{companyKey}/{shippingRequestKey}/printOriginal
GET Get Delayed Requests
Operation that gets the number of delayed shipping requests.
Response:
| When successful, the response body contains an item of type 'number'. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/shipping/shippingRequests/getDelayedRequests
GET /shipping/shippingRequests/getDelayedRequests
GET Get Partial Requests
Operation that gets the number of partial shipping requests.
Response:
| When successful, the response body contains an item of type 'number'. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/shipping/shippingRequests/getPartialRequests
GET /shipping/shippingRequests/getPartialRequests
GET Get Today Requests
Operation that gets the number of todya's shipping requests.
Response:
| When successful, the response body contains an item of type 'number'. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
api/{tenantKey}/{orgKey}/shipping/shippingRequests/getTodayRequests
GET /shipping/shippingRequests/getTodayRequests
Resources
MainResResource
The following elements are required:
| party | (string) The party that receives the goods. Depending on source document it can be either a customer or a supplier. Infered from the source document. |
| company | (string) The company code is the central organizational unit within the system. Infered from the source document. |
| documentStatus | (enum DocumentStatus) The document's status. Internally determined.
See DocumentStatus. |
| shippingRequestKey | (int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key. |
The following elements are optional:
| shippingRequestLines | (List of MainResShippingRequestLinesResource) The shipping's request lines.
See MainResShippingRequestLinesResource. |
| sourceDoc | (string) The source document using the format { |
MainResShippingRequestLinesResource
The following elements are required:
| documentLineStatus | (enum DocumentLineStatus) The document's line status. Infered from the source document line.
See DocumentLineStatus. |
| item | (string) The item representing the good to be shipped. Infered from source document line. |
| sourceDocLine | (int) The source document's line number. Internally determined. |
| unit | (string) The shipping request line item's unit. Infered from source document line. |
| unitPrice | (decimal) The shipping request line item's unit price. Infered from source document line. |
The following elements are optional:
| deliveryDate | (DateTime) The shipping request line expected delivery date. Infered from source document line. |
| description | (string) The shipping request line item's description. Infered from source document line. |
| discount1 | (decimal) The shipping request line item's discount 1 percentage. Infered from source document line. |
| openQuantity | (decimal) It indicates the current open quantity of the original document line. One original document document line can be partially settled over multiple deliveries. Internally determined. Infered from source document line. |
| quantity | (decimal) The shipping request line item's quantity. Infered from the source document line. |
| warehouse | (string) The shipping request line item's warehouse. Infered from source document line. |
ShippingRequestLineResource
The following elements are required:
| item | (string) The item representing the good to be shipped. Infered from source document line. |
| unitPrice | (decimal) The shipping request line item's unit price. Infered from source document line. |
| unit | (string) The shipping request line item's unit. Infered from source document line. |
| partyTaxSchema | (string) The party's tax schema. The tax schema identifies the group of taxes a party is liable for. Infered from source document line. |
| itemTaxSchema | (string) The shipping request item's tax schema. The tax schema identifies the group of taxes a item is liable for. Infered from source document line. |
| sourceDocLine | (int) The source document's line number. Internally determined. |
| sourceDocLineId | (Guid) The source documen'st line unique identifier. Internally determined. |
| documentLineStatus | (enum DocumentLineStatus) The document's line status. Infered from the source document line.
See DocumentLineStatus. |
| itemType | (enum ItemType) The shipping request line item's type. Infered from source document line.
See ItemType. |
The following elements are optional:
| description | (string) The shipping request line item's description. Infered from source document line. |
| complementaryDescription | (string) The shipping request line item's complementary description. Infered from source document line. |
| deliveryDate | (DateTime) The shipping request line expected delivery date. Infered from source document line. |
| quantity | (decimal) The shipping request line item's quantity. Infered from the source document line. |
| openQuantity | (decimal) It indicates the current open quantity of the original document line. One original document document line can be partially settled over multiple deliveries. Internally determined. Infered from source document line. |
| discount1 | (decimal) The shipping request line item's discount 1 percentage. Infered from source document line. |
| discount2 | (decimal) The shipping request line item's discount 2 percentage. This discount is applied over the remaining value after discount 1 is applied. Infered from source document line. |
| discount3 | (decimal) The shipping request line item's discount 3 percentage. This discount is applied over the remaining value after discount 1 and 2 are applied. Infered from source document line. |
| warehouse | (string) The shipping request line item's warehouse. Infered from source document line. |
| commitmentReference | (string) Commitment Reference. |
ShippingRequestResource
The following elements are required:
| shippingRequestKey | (int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key. |
| company | (string) The company code is the central organizational unit within the system. Infered from the source document.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service. |
| currency | (string) The money's unit used by the system, such as Euros (EUR) or United States Dollars (USD). This value is important for currency exchanges or to set the number of decimal places used to represent values. Infered from the source document.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service. |
| deliveryType | (string) The delivery's document type. Is either defined in source document type or in the sales setup configuration setting. Internally determined.
(fk) Allowed value: the natural key of a record of type DeliveryType. These records are accessibly through the DeliveryTypes service. |
| documentStatus | (enum DocumentStatus) The document's status. Internally determined.
See DocumentStatus. |
| party | (string) The party that receives the goods. Depending on source document it can be either a customer or a supplier. Infered from the source document.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service. |
| logisticsProcess | (enum LogisticsProcess) Defines the logistics process (either "Sales" or "Purchases"). Internally determined.
See LogisticsProcess. |
| sourceSchemaEntity | (string) The schema entity from originating document, possible values: Orders, Deliveries, GoodsReturns.
(fk) Allowed value: the natural key of a record of type SchemaEntity. These records are accessibly through the SchemaEntities service. |
| paymentMethod | (string) The financial transfer method used by the entity responsible for paying a transaction. For example, cash, transfer or check payments. Infered from the source document.
(fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service. |
| paymentTerm | (string) The term specifying the manner in which a trade will be done. Generally, these terms specify a period in which the buyer can pay the due amount. They can also demand some money to be paid in advance, paid in cash at delivery, a 30 day or longer period, or other similar arrangements for deferred payment. Infered from the source document.
(fk) Allowed value: the natural key of a record of type PaymentTerm. These records are accessibly through the PaymentTerms service. |
| accountingParty | (string) The party that will be used for payment purposes. It may or may not be the party to whom the goods or services are delivered. Infered from the source document.
(fk) Allowed value: the natural key of a record of type Party. These records are accessibly through the Parties service. |
The following elements are optional:
| deliveryTerm | (string) The conditions in a sales or transportation contract that specify the means of transportation. Infered from the source doc.
(fk) Allowed value: the natural key of a record of type DeliveryTerm. These records are accessibly through the DeliveryTerms service. |
| partyName | (string) The party's name. Inferred from the source socument. |
| partyAddress | (string) The party's address. Inferred from the source socument. |
| partyTaxId | (string) The party's tax code. Inferred from the source socument. |
| discount | (decimal) The discount's percentage. Infered from the source document. |
| loadingPoint | (string) The physical location where the goods are loaded. Infered from the source document. |
| loadingStreetName | (string) The street name of the physical location where the goods are loaded. Infered from the source document. |
| loadingBuildingNumber | (string) The building number of the physical location where the goods are loaded. Infered from the source document. |
| loadingPostalZone | (string) The postal zone of the physical location where the goods are loaded. Infered from the source document. |
| loadingCityName | (string) The city of the physical location where the goods are loaded. Infered from the source document. |
| loadingCountry | (string) The country of the physical location where the goods are loaded. Infered from the source document.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service. |
| loadingDateTime | (DateTimeOffset) The goods loading date and time from the loading physical location. Infered from the source document. |
| unloadingPoint | (string) The physical location where the goods are unloaded. Infered from the source document. |
| unloadingStreetName | (string) The street name of the physical location where the goods are unloaded. Infered from the source document. |
| unloadingBuildingNumber | (string) The building number of the physical location where the goods are unloaded. Infered from the source document. |
| unloadingPostalZone | (string) The postal zone of the physical location where the goods are unloaded. Infered from the source document. |
| unloadingCityName | (string) The city of the physical location where the goods are unloaded. Infered from the source document. |
| unloadingCountry | (string) The country of the physical location where the goods are unloaded. Infered from the source document.
(fk) Allowed value: the natural key of a record of type Country. These records are accessibly through the Countries service. |
| unloadingDateTime | (DateTimeOffset) The goods unloading date and time from the loading physical location. Infered from the source document. |
| sourceDoc | (string) The source document using the format { |
| sourceDocId | (Guid) The unique identitifer of the source document whose type is defined in the SourceSchemaEntity. Internally determined. |
| shippingRequestLines | (List of ShippingRequestLineResource) The shipping's request lines.
See ShippingRequestLineResource. |
| sourceDocDate | (DateTimeOffset) The source document's date. Internally determined. |
| taxIncluded | (bool) Indicates whether the unit prices have taxes included or not. Infered from the source document. |
| accountingPartyName | (string) The accounting's party name. Infered from the source document. |
| accountingPartyAddress | (string) The accounting's party address. Infered from the source document. |
| discountInValueAmount | (decimal) The discount in value. Infered from the source document. |