| Description | Manage Outbound Deliveries Extension |
| Name | ManageODExtensionIn |
| Namespace | http://sap.com/xi/A1SGlobalization/Global |
| Process Component Description | Outbound Delivery Processing |
| Process Component Name | OutboundDeliveryProcessing |
| Process Component Namespace | http://sap.com/xi/AP/LogisticsExecution/Global |
| Deployment Unit Description | Production and Site Logistics Execution |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Not Released |
An interface to read outbound delivery extension fields.
The web service interface 'Manage Outbound Delivery Extension In' is used to read relevant fields for localization use cases from existing outbound deliveries by 'ID' / 'UUID' (Universally Unique Identifier).
The web service interface offers the operation ReadOD and is used to read instances of the outbound delivery. The input is the ID of the Outbound Delivery or the UUID returned by QueryOutboundDeliveryIn.
Here is an example of a simple web service request:
<n0:ODByUUIDQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <OutboundDelivery> <UUID>00163EAC-AF0A-1EAA-BE90-5F0FD4711826</UUID> </OutboundDelivery> </n0:ODByUUIDQuery_sync>
Existence of an outbound delivery: If an outbound delivery does not exist in the system, no data will be returned by the web service.
Restriction to outbound deliveries in India: The service interface is currently localized for India E-Invoicing. For all other outbound deliveries, no data will be returned by the web service.
You can find general information about Web services, their structure and consumption in the Web Services documentation. Please open the Web Services document in a new window.
Possible scenarios include the following:
Query Outbound Delivery: The FIND_BY_ELEMENTS operation is used to bring the existing outbound delivery in the system through a third party freight forwarder.
<n0:OutboundDeliveryFindByElementsQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <OutboundDeliveryFindByElementsRequestMessageBody> <SelectionByID> <InclusionExclusionCode>I</InclusionExclusionCode> <IntervalBoundaryTypeCode>1</IntervalBoundaryTypeCode> <LowerBoundaryIdentifier>567</LowerBoundaryIdentifier> </SelectionByID> </OutboundDeliveryFindByElementsRequestMessageBody> <ProcessingConditions> <QueryHitsMaximumNumberValue>1</QueryHitsMaximumNumberValue> <QueryHitsUnlimitedIndicator>true</QueryHitsUnlimitedIndicator> </ProcessingConditions> </n0:OutboundDeliveryFindByElementsQuery_sync>
<nm:OutboundDeliveryFindByElementsResponse_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ASL:/1SAI/TASB3874B85765D6F458A7F:804"> <ProcessingConditions> <ReturnedQueryHitsNumberValue>0</ReturnedQueryHitsNumberValue> <MoreHitsAvailableIndicator>false</MoreHitsAvailableIndicator> </ProcessingConditions> <Log/> </nm:OutboundDeliveryFindByElementsResponse_sync>
| Description | Read outbound deliveries extension |
| Name | Read |
| Synchronous | yes |
| Release Status | Released |
To read outbound delivery fields for the localization use case of India E-Invoicing.
The operation ReadOD reads the extension fields of the outbound delivery business object. Extension fields refer to localization-specific fields of the Outbound Delivery.
The outbound delivery ID / UUID (Universally Unique Identifier) must be available.
ID: ID of the outbound delivery.
UUID: UUID (Universally Unique Identifier) is a unique identifier of the outbound delivery.
Request: Read Outbound Delivery
<n0:ODByUUIDQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <OutboundDelivery> <UUID>00163EAC-AF0A-1EAA-BE90-5F0FD4711826</UUID> </OutboundDelivery> </n0:ODByUUIDQuery_sync>
The response message structure contains the information related to the outbound delivery.
| Element | Description |
|---|---|
| UUID | UUID (Universally Unique Identifier) is a unique identifier of the outbound delivery |
| ID | Identifier for a specific outbound delivery |
| Date | Date of outbound delivery |
| Status | Provides various status information of the delivery |
| ShipToLocation | The location to which the products are to be shipped |
| ShipFromLocation | The location from where the products are to be shipped |
| ProductRecipientParty | The party who will be receiving the product |
| SellerParty | Seller Party |
| Item | Shows all the item details |
Status
There are different status codes involved in the outbound delivery as mentioned below:
ConsistencyStatusCode and ItemListConsistencyStatusCode
The runtime code list are as stated below:
| Runtime Code | Description |
|---|---|
| 1 | Check Pending |
| 2 | Inconsistent |
| 3 | Consistent |
ReleaseStatusCode
The runtime code list are as stated below:
| Runtime Code | Description |
|---|---|
| 1 | Not Released |
| 2 | Partially Released |
| 3 | Released |
| 4 | Release Discarded |
| 5 | Release Canceled |
| 6 | Not Relevant |
| 7 | Release Cancellation Requested |
| 8 | Release Requested |
LegalApprovalStatusCode
The runtime code list are as stated below:
| Runtime Code | Description |
|---|---|
| 1 | Not Started |
| 2 | Approval not Necessary |
| 3 | In Approval |
| 4 | Approved |
| 6 | In Revision |
Response:
Show full documentation
Show full documentation<n0:ODByUUIDResponse_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"
xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TASB2649986A0EDD471AC99:804">
<OutboundDeliveryExtension>
<UUID>00163eac-af3d-1edb-8881-879536f6a3df</UUID>
<ID>INTR-358</ID>
<Status>
<ConsistencyStatusCode>3</ConsistencyStatusCode>
<ItemListConsistencyStatusCode>3</ItemListConsistencyStatusCode>
<ReleaseStatusCode>1</ReleaseStatusCode>
<LegalApprovalStatus>3</LegalApprovalStatus>
</Status>
<ShipToLocation>
<LocationID>GCIN64000</LocationID>
<LocationUUID>00000000-0001-02dc-b3aa-79abaa64c544</LocationUUID>
<TaxID schemeID="GSTIN">GSTINKERALA</TaxID>
<FormattedName>AHT Mumbai</FormattedName>
<FormattedAddressDescription>AHT Mumbai / 10 Borivalli / Mumbai 400002 / IN</FormattedAddressDescription>
<CityName>Mumbai</CityName>
<StreetPostalCode>400002</StreetPostalCode>
<RegionCode listID="IN">27</RegionCode>
</ShipToLocation>
<ShipFromLocation>
<LocationID>GCIN61000</LocationID>
<LocationUUID>00000000-0001-02dc-b3aa-6c734b5118b8</LocationUUID>
<TaxID schemeID="GSTIN">GST123456789</TaxID>
<FormattedName>AHT Mysuru</FormattedName>
<FormattedAddressDescription>AHT Mysuru / 58 Kalidasa Road / Mysore 570002 / IN</FormattedAddressDescription>
<CityName>Mysore</CityName>
<StreetPostalCode>570002</StreetPostalCode>
<RegionCode listID="IN">29</RegionCode>
</ShipFromLocation>
<ProductRecipientParty>
<PartyKey>
<PartyTypeCode>209</PartyTypeCode>
<PartyID>GCIN64000</PartyID>
</PartyKey>
<PartyUUID>00000000-0001-02ec-b3db-31fe74c2db78</PartyUUID>
<FormattedName>AHT Mumbai</FormattedName>
<FormattedAddressDescription>AHT Mumbai / 10 Borivalli / Mumbai 400002 / IN</FormattedAddressDescription>
</ProductRecipientParty>
<SellerParty>
<PartyKey>
<PartyTypeCode>154</PartyTypeCode>
<PartyID>GCIN10000</PartyID>
</PartyKey>
<PartyUUID>00000000-0001-02ec-b3db-323612e91de3</PartyUUID>
<FormattedName>Akron Heating India Inc.</FormattedName>
<FormattedAddressDescription>Akron Heating India Inc. / 567 Connaught place / New Delhi 110001 / IN</FormattedAddressDescription>
<RegionCode listID="IN">07</RegionCode>
</SellerParty>
<Item>
<UUID>00163eac-af3d-1edb-8881-877536f703df</UUID>
<ID>10</ID>
<ProductExtension>
<ProductKey>
<ProductTypeCode>1</ProductTypeCode>
<ProductID>GCINR-CIN1</ProductID>
</ProductKey>
<ProductUUID>00000000-0001-02dc-b8fe-a6bcc0d7408a</ProductUUID>
<ProductHSNCode>00440015</ProductHSNCode>
</ProductExtension>
<DeliveryQuantityExtension>
<Quantity unitCode="EA">1.0</Quantity>
<QuantityName languageCode="EN">eac</QuantityName>
</DeliveryQuantityExtension>
<PriceAndTax>
<GrossAmount currencyCode="INR">10.0</GrossAmount>
<TaxCountryCode>IN</TaxCountryCode>
<PriceComponents>
<Description languageCode="EN">Interstate GST</Description>
<TypeCode>44</TypeCode>
<TypeName languageCode="EN">Interstate GST</TypeName>
<Rate>
<DecimalValue>18.0</DecimalValue>
<MeasureUnitCode>P1</MeasureUnitCode>
</Rate>
<CalculatedAmount currencyCode="INR">1.8</CalculatedAmount>
</PriceComponents>
<PriceComponents>
<Description languageCode="EN">List Price</Description>
<TypeCode>7PR1</TypeCode>
<TypeName languageCode="EN">List Price</TypeName>
<Rate>
<DecimalValue>0.0</DecimalValue>
<MeasureUnitCode>P1</MeasureUnitCode>
</Rate>
<CalculatedAmount currencyCode="INR">10.0</CalculatedAmount>
</PriceComponents>
<PriceComponents>
<Description languageCode="EN">Assessible Amount</Description>
<TypeCode>01PB</TypeCode>
<TypeName languageCode="EN">Assessible Amount</TypeName>
<Rate>
<DecimalValue>0.0</DecimalValue>
<MeasureUnitCode>P1</MeasureUnitCode>
</Rate>
<CalculatedAmount currencyCode="INR">10.0</CalculatedAmount>
</PriceComponents>
</PriceAndTax>
</Item>
</OutboundDeliveryExtension>
</n0:ODByUUIDResponse_sync>
The ReadOD operation can currently only be used to read the fields of the outbound delivery for the localization use case of India E-Invoicing. For reading the complete details of an outbound delivery, the ReadOD operation of the ManageOutboundDeliveryIn service interface can be used.