Scribd
Upload
48 views9 pages

OData Services Documentation

The document describes an OData service that provides access to purchase order data including purchase order headers, items, schedule lines, and services. It provides the base URL and metadata endpoint for the service. It then describes each entity set including applicable filtering options, URL structures, example requests and responses, and navigation properties between entities.

Uploaded by

yograj.abap2
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
48 views9 pages

OData Services Documentation

The document describes an OData service that provides access to purchase order data including purchase order headers, items, schedule lines, and services. It provides the base URL and metadata endpoint for the service. It then describes each entity set including applicable filtering options, URL structures, example requests and responses, and navigation properties between entities.

Uploaded by

yograj.abap2
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 9

Contents

Introduction.................................................................................................................................................................... 2
Metadata Endpoint.........................................................................................................................................................2
OData Service URLs.........................................................................................................................................................2
Base URL......................................................................................................................................................................2
POHeaderSet – Purchase Order Header..........................................................................................................................2
Applicable Filtering......................................................................................................................................................2
Format Options...........................................................................................................................................................3
Complete URL Example...............................................................................................................................................3
Output Payload............................................................................................................................................................3
Navigation URLs:..........................................................................................................................................................3
Navigation to Item Set:............................................................................................................................................3
POItemSet – Purchase Order Item...................................................................................................................................4
URL.............................................................................................................................................................................. 4
Applicable Filtering......................................................................................................................................................4
Format Options...........................................................................................................................................................4
Complete URL Example...............................................................................................................................................4
Output Payload............................................................................................................................................................4
Navigation URLs...........................................................................................................................................................5
Navigation to Service Set:........................................................................................................................................5
Navigation to Header:..............................................................................................................................................5
Navigation to Schedule Line Set:.............................................................................................................................5
URL.............................................................................................................................................................................. 5
Format Options...........................................................................................................................................................6
Complete URL Example...............................................................................................................................................6
Navigation URLs...........................................................................................................................................................7
Navigation to Purchase Order Item:........................................................................................................................7
POServiceSet – Purchase Order Service......................................................................................................................7
URL.............................................................................................................................................................................. 7
Applicable Filtering......................................................................................................................................................7
Format Options...........................................................................................................................................................7
Complete URL Example...............................................................................................................................................7
Navigation URLs...........................................................................................................................................................8
Navigation to Purchase Order Item:........................................................................................................................8
Attachments....................................................................................................................................................................8

1|Page
Supplier X OData Services Documentation
Introduction

Supplier X provides OData services to access and manipulate Purchase Order data. The following entities
are available:
1. POHeaderSet – P
No index entries found.urchase Order Header
2. POItemSet – Purchase Order Item
3. POScheduleLineSet – Purchase Order Schedule Line
4. POServiceSet – Purchase Order Service

Metadata Endpoint

URL : http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/$metadata
This URL is used to request the metadata of the OData service. The metadata document describes the
structure of the service, including entities, properties, relationships, and other relevant information.

OData Service URLs


Base URL

http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV
This is the base URL of the OData service, specifying the protocol, domain, port, and the path to the SAP
OData service.

POHeaderSet – Purchase Order Header

URL: http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/POHeaderSet

Applicable Filtering

?$filter=PurchaseOrder eq '4100003024’ and PurchaseOrderType eq 'NB' and PurchasingDocumentOrigin


eq '9' and PurchasingProcessingStatus eq '02' and ReleaseCode ne 'R' and CompanyCode eq '1006' and
Supplier eq '6200000129'
This URI allows you to filter data based on specific conditions.
2|Page
Format Options
1. &$format=json
2. &$format=xlsx

Complete URL Example


http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/POHeaderSet?
$filter=PurchaseOrder eq '4100003024' and PurchaseOrderType eq 'NB' and PurchasingDocumentOrigin eq
'9' and PurchasingProcessingStatus eq '02' and ReleaseCode ne 'R' and CompanyCode eq '1006' and
Supplier eq '6200000129'&$format=json

Output Payload
{
"d" : {
"results" : [
{
"__metadata" : {
"id" : "http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/
ZSUPPLIERX_SRV/POHeaderSet('4100003024')",
"uri" : "http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/
ZSUPPLIERX_SRV/POHeaderSet('4100003024')",
"type" : "ZSUPPLIERX_SRV.POHeader"
},
"PurchaseOrder" : "4100003024",
"PurchaseOrderType" : "NB",
"PurchaseOrderSubtype" : "",
"PurchasingDocumentOrigin" : "9",
"CreatedByUser" : "10000307",
"Language" : "E",
// ... (other properties)
"POItemSet" : {
"__deferred" : {
"uri" : "http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/
ZSUPPLIERX_SRV/POHeaderSet('4100003024')/POItemSet"
}
}
}
]
}
}

Navigation URLs:
Navigation to Item Set:
http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/POHeaderSet('4100003024')/
POItemSet
This URL allows you to navigate to the set of Purchase Order Items related to the specific Purchase Order
Header. It can be used to fetch information about the individual items associated with the header.

3|Page
POItemSet – Purchase Order Item

URL
http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/POItemSet

Applicable Filtering
?$filter=PurchaseOrder eq '4600000585' and PurchaseOrderItem eq '00010' and PurchaseOrderCategory
eq 'F' and PurchasingDocumentDeletionCode ne 'X' and IsCompletelyDelivered ne 'X'

Format Options
1. &$format=json
2. &$format=xlsx

Complete URL Example


http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/POItemSet?
$filter=PurchaseOrder eq '4600000585' and PurchaseOrderItem eq '00010' and PurchaseOrderCategory eq
'F' and PurchasingDocumentDeletionCode ne 'X' and IsCompletelyDelivered ne 'X'&$format=json

Output Payload
{
"d" : {
"results" : [
{
"__metadata" : {
"id" :
"http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/
POItemSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010')",
"uri" :
"http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/
POItemSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010')",
"type" : "ZSUPPLIERX_SRV.POItem"
},
"PurchaseOrder" : "4600000585",
"PurchaseOrderItem" : "00010",
"PurchaseOrderItemUniqueID" : "460000058500010",
"PurchaseOrderItemText" : "TEST",
// ... (other properties)
"POServiceSet" : {
"__deferred" : {
"uri" :
"http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/
POItemSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010')/POServiceSet"
}
},
"POHeader" : {
"__deferred" : {

4|Page
"uri" :
"http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/
POItemSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010')/POHeader"
}
},
"POScheduleLineSet" : {
"__deferred" : {
"uri" :
"http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/
POItemSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010')/
POScheduleLineSet"
}
}
}
]
}
}

Navigation URLs
Navigation to Service Set:
http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/
POItemSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010')/POServiceSet
This URL allows you to navigate to the service set related to the specific Purchase Order Item. It can be used
to fetch information about services associated with the item.

Navigation to Header:
http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/
POItemSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010')/POHeader
This URL allows you to navigate to the header information related to the specific Purchase Order Item. It
can be used to fetch details about the entire Purchase Order to which the item belongs.

Navigation to Schedule Line Set:


http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/
POItemSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010')/POScheduleLineSet
This URL allows you to navigate to the set of schedule lines related to the specific Purchase Order Item. It
can be used to retrieve information about the schedule lines associated with the item.

POScheduleLineSet – Purchase Order Schedule Line


URL
http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/POScheduleLineSet

Applicable Filtering

?$filter=PurchaseOrder eq '4600000585' and PurchaseOrderItem eq '00010' and


PurchaseOrderScheduleLine eq '0001'

5|Page
Format Options
1. &$format=json
2. &$format=xlsx

Complete URL Example


http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/POScheduleLineSet?
$filter=PurchaseOrder eq '4600000585' and PurchaseOrderItem eq '00010' and
PurchaseOrderScheduleLine eq '0001'&$format=json
Output Payload
{
"d" : {
"results" : [
{
"__metadata" : {
"id" : "http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/
ZSUPPLIERX_SRV/
POScheduleLineSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010',Purchase
OrderScheduleLine='0001')",
"uri" : "http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/
ZSUPPLIERX_SRV/
POScheduleLineSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010',Purchase
OrderScheduleLine='0001')",
"type" : "ZSUPPLIERX_SRV.POScheduleLine"
},
"PurchaseOrder" : "4600000585",
"PurchaseOrderItem" : "00010",
"PurchaseOrderScheduleLine" : "0001",
"PerformancePeriodStartDate" : "00000000",
"PerformancePeriodEndDate" : "00000000",
"DelivDateCategory" : "1",
"ScheduleLineDeliveryDate" : "20231221",
"ScheduleLineDeliveryTime" : "000000",
"ScheduleLineOrderQuantity" : "1.000",
"RoughGoodsReceiptQty" : "0.000",
"PurchaseOrderQuantityUnit" : "C62",
// ... (other properties)
"POItem" : {
"__deferred" : {
"uri" : "http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/
ZSUPPLIERX_SRV/
POScheduleLineSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010',Purchase
OrderScheduleLine='0001')/POItem"
}
}
}
]
}
}
6|Page
Navigation URLs
Navigation to Purchase Order Item:
http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/
POScheduleLineSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010',PurchaseOrderScheduleLine
='0001')/POItem
This URL allows you to navigate to the related Purchase Order Item for the specific Purchase Order
Schedule Line. It can be used to fetch information about the item associated with the schedule line.

POServiceSet – Purchase Order Service


URL
http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/POServiceSet

Applicable Filtering

?$filter=PurchaseOrder eq '4600000585' and PurchaseOrderItem eq '00010'&$format=json

Format Options
1. &$format=json
2. &$format=xlsx

Complete URL Example


http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/POScheduleLineSet?
$filter=PurchaseOrder eq '4600000585' and PurchaseOrderItem eq '00010' and
PurchaseOrderScheduleLine eq '0001'&$format=json
Output Payload
{
"d" : {
"results" : [
{
"__metadata" : {
"id" : "http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/
ZSUPPLIERX_SRV/
POServiceSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010',ServicePackag
e='0000017841',SubPackno='0000017842',Line='0000000002')",
"uri" : "http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/
ZSUPPLIERX_SRV/
POServiceSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010',ServicePackag
e='0000017841',SubPackno='0000017842',Line='0000000002')",
"type" : "ZSUPPLIERX_SRV.POService"
},
"PurchaseOrder" : "4600000585",
"PurchaseOrderItem" : "00010",
"ServicePackage" : "0000017841",
"SubPackno" : "0000017842",

7|Page
"Line" : "0000000002",
"LineNumber" : "0000000010",
"DeletionIndicator" : "",
"ActivityNumber" : "000000000003002340",
"Quantity" : "10.000",
"BaseUnitOfMeasure" : "LE",
"PriceUnit" : "1",
"GrossPrice" : "10000.000",
"NetValue" : "10000.000",
"ShortText" : "DOMESTIC WEIGHT BRIDGE WEIGHTMENT CHARGE",
"POItem" : {
"__deferred" : {
"uri" : "http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/
ZSUPPLIERX_SRV/
POServiceSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010',ServicePackag
e='0000017841',SubPackno='0000017842',Line='0000000002')/POItem"
}
}
}
]
}
}

Navigation URLs
Navigation to Purchase Order Item:
http://aacldvapp.aeonx.digital:8000/sap/opu/odata/sap/ZSUPPLIERX_SRV/
POServiceSet(PurchaseOrder='4600000585',PurchaseOrderItem='00010',ServicePackage='0000017841',Su
bPackno='0000017842',Line='0000000002')/POItem
This URL allows you to navigate to the related Purchase Order Item for the specific Purchase Order Service.
It can be used to fetch information about the item associated with the service.

Attachments
Master Data

Purchase Order Header – Sample URL and


Payload in JSON

Purchase Order Line Item – Sample URL and


Payload in JSON

Purchase Order Schedule Line – Sample URL


and Payload in JSON

Purchase Order Services – Sample URL and


Payload in JSON

8|Page
Postman Collection of APIs

9|Page

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy