Shipping | Shipping Request

The shipping request entity is used to store information related with the shipping requests.

Overview

URL	api/{tenantKey}/{orgKey}/shipping/shippingRequests
Methods Supported	GET, POST, PUT, DELETE

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
• POST:
  • POST ShippingRequests
  • POST Shipping Request
• PUT:
  • PUT Set IsActive ShippingRequest
  • PUT Set ShippingRequestKey ShippingRequest
  • PUT Set Company ShippingRequest
  • PUT Set Currency ShippingRequest
  • PUT Set DeliveryType ShippingRequest
  • PUT Set DeliveryTerm ShippingRequest
  • PUT Set DocumentStatus ShippingRequest
  • PUT Set Party ShippingRequest
  • PUT Set PartyName ShippingRequest
  • PUT Set PartyAddress ShippingRequest
  • PUT Set PartyTaxId ShippingRequest
  • PUT Set Discount ShippingRequest
  • PUT Set LogisticsProcess ShippingRequest
  • PUT Set LoadingPoint ShippingRequest
  • PUT Set LoadingStreetName ShippingRequest
  • PUT Set LoadingBuildingNumber ShippingRequest
  • PUT Set LoadingPostalZone ShippingRequest
  • PUT Set LoadingCityName ShippingRequest
  • PUT Set LoadingCountry ShippingRequest
  • PUT Set UnloadingPoint ShippingRequest
  • PUT Set UnloadingStreetName ShippingRequest
  • PUT Set UnloadingBuildingNumber ShippingRequest
  • PUT Set UnloadingPostalZone ShippingRequest
  • PUT Set UnloadingCityName ShippingRequest
  • PUT Set UnloadingCountry ShippingRequest
  • PUT Set SourceSchemaEntity ShippingRequest
  • PUT Set SourceDoc ShippingRequest
  • PUT Set SourceDocId ShippingRequest
  • PUT Set PaymentMethod ShippingRequest
  • PUT Set PaymentTerm ShippingRequest
  • PUT Set SourceDocDate ShippingRequest
  • PUT Set TaxIncluded ShippingRequest
  • PUT Set AccountingPartyName ShippingRequest
  • PUT Set AccountingPartyAddress ShippingRequest
  • PUT Set AccountingParty ShippingRequest
  • PUT Set DeliveryMode ShippingRequest
  • PUT Set DimensionSet ShippingRequest
  • PUT Set CustomAttributes ShippingRequest
  • PUT Set Item ShippingRequestLine
  • PUT Set Description ShippingRequestLine
  • PUT Set ComplementaryDescription ShippingRequestLine
  • PUT Set DeliveryDate ShippingRequestLine
  • PUT Set Quantity ShippingRequestLine
  • PUT Set OpenQuantity ShippingRequestLine
  • PUT Set UnitPrice ShippingRequestLine
  • PUT Set Unit ShippingRequestLine
  • PUT Set Discount1 ShippingRequestLine
  • PUT Set Discount2 ShippingRequestLine
  • PUT Set Discount3 ShippingRequestLine
  • PUT Set Warehouse ShippingRequestLine
  • PUT Set ItemTaxSchema ShippingRequestLine
  • PUT Set SourceDocLine ShippingRequestLine
  • PUT Set SourceDocLineId ShippingRequestLine
  • PUT Set DocumentLineStatus ShippingRequestLine
  • PUT Set SourceOrder ShippingRequestLine
  • PUT Set SourceOrderId ShippingRequestLine
  • PUT Set SourceOrderLine ShippingRequestLine
  • PUT Set SourceOrderLineId ShippingRequestLine
  • PUT Set SourceOrderSchemaEntityId ShippingRequestLine
  • PUT Set DimensionSet ShippingRequestLine
  • PUT Set CommitmentReference ShippingRequestLine
  • PUT Set CustomAttributes ShippingRequestLine
• DELETE:
  • DELETE Shipping Request Line by identifier
  • DELETE ShippingRequest by identifier
  • DELETE ShippingRequest by key

All Resources

This service uses the following resources:

• ApiShippingRequestResource
• ApiShippingRequestShippingRequestLinesResource
• MainResResource
• MainResShippingRequestLinesResource
• ShippingRequestLineResource
• ShippingRequestResource

All Enumerations

This service uses the following enumerations:

• DocumentLineStatus
• DocumentStatus
• ItemType
• LogisticsProcess

GET Operations

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:

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:

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:

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:

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:

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:

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:

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:

GET Get Delayed Requests

Custom operation 'GetDelayedRequests'.

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:

GET Get Partial Requests

Custom operation 'GetPartialRequests'.

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:

GET Get Today Requests

Custom operation 'GetTodayRequests'.

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:

POST Operations

POST ShippingRequests

Creates a new entity record.

The following elements are required:

shippingRequestResource

(ApiShippingRequestResource) The request body should contain the entity record that should be created. See ApiShippingRequestResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiShippingRequestResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

POST Shipping Request

Inserts a new 'Shipping Request Line' in the 'Shipping Request'.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(ApiShippingRequestShippingRequestLinesResource) The ApiShippingRequestShippingRequestLinesResource instance. See ApiShippingRequestShippingRequestLinesResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Operations

PUT Set AccountingParty ShippingRequest

Updates the value of attribute 'AccountingParty' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set AccountingPartyAddress ShippingRequest

Updates the value of attribute 'AccountingPartyAddress' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set AccountingPartyName ShippingRequest

Updates the value of attribute 'AccountingPartyName' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set CommitmentReference ShippingRequestLine

Updates the value of attribute 'CommitmentReference' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Company ShippingRequest

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set ComplementaryDescription ShippingRequestLine

Updates the value of attribute 'ComplementaryDescription' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Currency ShippingRequest

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set CustomAttributes ShippingRequest

Updates the value of attribute 'CustomAttributes' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set CustomAttributes ShippingRequestLine

Updates the value of attribute 'CustomAttributes' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DeliveryDate ShippingRequestLine

Updates the value of attribute 'DeliveryDate' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(DateTime) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DeliveryMode ShippingRequest

Updates the value of attribute 'DeliveryMode' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DeliveryTerm ShippingRequest

Updates the value of attribute 'DeliveryTerm' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DeliveryType ShippingRequest

Updates the value of attribute 'DeliveryType' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Description ShippingRequestLine

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DimensionSet ShippingRequest

Updates the value of attribute 'DimensionSet' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DimensionSet ShippingRequestLine

Updates the value of attribute 'DimensionSet' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Discount ShippingRequest

Updates the value of attribute 'Discount' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Discount1 ShippingRequestLine

Updates the value of attribute 'Discount1' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Discount2 ShippingRequestLine

Updates the value of attribute 'Discount2' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Discount3 ShippingRequestLine

Updates the value of attribute 'Discount3' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DocumentLineStatus ShippingRequestLine

Updates the value of attribute 'DocumentLineStatus' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum DocumentLineStatus) The request body should contain the new value for the attribute. See DocumentLineStatus.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set DocumentStatus ShippingRequest

Updates the value of attribute 'DocumentStatus' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(enum DocumentStatus) The request body should contain the new value for the attribute. See DocumentStatus.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IsActive ShippingRequest

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

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:

PUT Set Item ShippingRequestLine

Updates the value of attribute 'Item' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set ItemTaxSchema ShippingRequestLine

Updates the value of attribute 'ItemTaxSchema' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set LoadingBuildingNumber ShippingRequest

Updates the value of attribute 'LoadingBuildingNumber' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set LoadingCityName ShippingRequest

Updates the value of attribute 'LoadingCityName' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set LoadingCountry ShippingRequest

Updates the value of attribute 'LoadingCountry' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set LoadingPoint ShippingRequest

Updates the value of attribute 'LoadingPoint' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set LoadingPostalZone ShippingRequest

Updates the value of attribute 'LoadingPostalZone' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set LoadingStreetName ShippingRequest

Updates the value of attribute 'LoadingStreetName' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set LogisticsProcess ShippingRequest

Updates the value of attribute 'LogisticsProcess' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(enum LogisticsProcess) The request body should contain the new value for the attribute. See LogisticsProcess.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set OpenQuantity ShippingRequestLine

Updates the value of attribute 'OpenQuantity' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Party ShippingRequest

Updates the value of attribute 'Party' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set PartyAddress ShippingRequest

Updates the value of attribute 'PartyAddress' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set PartyName ShippingRequest

Updates the value of attribute 'PartyName' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set PartyTaxId ShippingRequest

Updates the value of attribute 'PartyTaxId' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set PaymentMethod ShippingRequest

Updates the value of attribute 'PaymentMethod' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set PaymentTerm ShippingRequest

Updates the value of attribute 'PaymentTerm' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Quantity ShippingRequestLine

Updates the value of attribute 'Quantity' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set ShippingRequestKey ShippingRequest

Updates the value of attribute 'ShippingRequestKey' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceDoc ShippingRequest

Updates the value of attribute 'SourceDoc' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceDocDate ShippingRequest

Updates the value of attribute 'SourceDocDate' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceDocId ShippingRequest

Updates the value of attribute 'SourceDocId' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceDocLine ShippingRequestLine

Updates the value of attribute 'SourceDocLine' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceDocLineId ShippingRequestLine

Updates the value of attribute 'SourceDocLineId' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceOrder ShippingRequestLine

Updates the value of attribute 'SourceOrder' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceOrderId ShippingRequestLine

Updates the value of attribute 'SourceOrderId' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceOrderLine ShippingRequestLine

Updates the value of attribute 'SourceOrderLine' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceOrderLineId ShippingRequestLine

Updates the value of attribute 'SourceOrderLineId' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceOrderSchemaEntityId ShippingRequestLine

Updates the value of attribute 'SourceOrderSchemaEntityId' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SourceSchemaEntity ShippingRequest

Updates the value of attribute 'SourceSchemaEntity' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set TaxIncluded ShippingRequest

Updates the value of attribute 'TaxIncluded' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Unit ShippingRequestLine

Updates the value of attribute 'Unit' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set UnitPrice ShippingRequestLine

Updates the value of attribute 'UnitPrice' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set UnloadingBuildingNumber ShippingRequest

Updates the value of attribute 'UnloadingBuildingNumber' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set UnloadingCityName ShippingRequest

Updates the value of attribute 'UnloadingCityName' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set UnloadingCountry ShippingRequest

Updates the value of attribute 'UnloadingCountry' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set UnloadingPoint ShippingRequest

Updates the value of attribute 'UnloadingPoint' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set UnloadingPostalZone ShippingRequest

Updates the value of attribute 'UnloadingPostalZone' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set UnloadingStreetName ShippingRequest

Updates the value of attribute 'UnloadingStreetName' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Warehouse ShippingRequestLine

Updates the value of attribute 'Warehouse' in the specified entity record.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

DELETE Operations

DELETE Shipping Request Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

shippingRequestKey	(int) The sequential number internally determined that uniquely identifies the shipping request. The document natural key.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE ShippingRequest by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE ShippingRequest by key

Deletes 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 is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

Resources

ApiShippingRequestResource

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.
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.
deliveryType	(string) The delivery's document type. Is either defined in source document type or in the sales setup configuration setting. Internally determined.
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.
logisticsProcess	(enum LogisticsProcess) Defines the logistics process (either "Sales" or "Purchases"). Internally determined. See LogisticsProcess.
loadingCountry	(string) The country of the physical location where the goods are loaded. Infered from the source document.
sourceSchemaEntity	(string) The schema entity from originating document, possible values: Orders, Deliveries, GoodsReturns.
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.
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.
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.

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.
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.
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.
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 {..}. The source document is usually the order (either sales. or purchase order). Internally determined.
sourceDocId	(Guid) The unique identitifer of the source document whose type is defined in the SourceSchemaEntity. Internally determined.
shippingRequestLines	(List of ApiShippingRequestShippingRequestLinesResource) The shipping's request lines. See ApiShippingRequestShippingRequestLinesResource.
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.
deliveryMode	(string) The delivery mode (ex: mail).
dimensionSet	(string) Dimension Set.
customAttributes	(string) The order custom attributes.

ApiShippingRequestShippingRequestLinesResource

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.
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.

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.
sourceOrder	(string) The order that origin this line.
sourceOrderId	(Guid) The order id that origin this line.
sourceOrderLine	(int) The order line index that origin this line.
sourceOrderLineId	(Guid) The order line id that origin this line.
sourceOrderSchemaEntityId	(Guid) The order schema id that origin this line.
dimensionSet	(string) Dimension Set.
commitmentReference	(string) The state supplier commitment reference.
customAttributes	(string) The order line custom attributes.

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 {..}. The source document is usually the order (either sales. or purchase order). Internally determined.

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.
sourceOrder	(string) The order that origin this line.
sourceOrderId	(Guid) The order id that origin this line.
sourceOrderLine	(int) The order line index that origin this line.
sourceOrderLineId	(Guid) The order line id that origin this line.
sourceOrderSchemaEntityId	(Guid) The order schema id that origin this line.
dimensionSet	(string) Dimension Set.
commitmentReference	(string) The state supplier commitment reference.
customAttributes	(string) The order line custom attributes.

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.
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.
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.
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 {..}. The source document is usually the order (either sales. or purchase order). Internally determined.
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.
deliveryMode	(string) The delivery mode (ex: mail). (fk) Allowed value: the natural key of a record of type DeliveryMode. These records are accessibly through the DeliveryModes service.
dimensionSet	(string) Dimension Set. (fk) Allowed value: the natural key of a record of type DimensionSet. These records are accessibly through the DimensionSets service.
customAttributes	(string) The order custom attributes.

Enumerations

DocumentLineStatus

1	Open
2	Completed

DocumentStatus

1	Open
2	Completed
3	Processing

ItemType

1	Item
2	Service

LogisticsProcess

1	Sales
2	Purchases
3	OwnAssetMovements