REST API for Oracle Supply Chain Management Cloud

Create B2B messages

post

/fscmRestApi/resources/11.13.18.05/b2bMessages

Request

Header Parameters

AgentID:

This is the service provider ID if a service provider is used to send B2B messages, for example, XYZ Service Provider. If Agent information isn't passed as a header, it's assumed that no service provider is being used, that is, the value for service provider is None.
AgentIDType:
This is the type of service provider ID if a service provider is used to send B2B messages, for example, Name. If Agent information isn't passed as a header, it's assumed that no service provider is being used, that is, the value for service provider is None.
Example:
```
Name
```
Content-Type(required):
Specifies the type of content being sent to the server. The valid value is application/xml.
Example:
```
[
    "application/xml"
]
```

DocumentType(required):

Type of document that's being sent

Example:

[
    "AcknowledgeChangePurchaseOrder",
    "AcknowledgePurchaseOrder",
    "SupplyPlanningData",
    "AcknowledgeInvoice",
    "ProcessForecast",
    "SupplyForecast",
    "AcknowledgeReceiptAdvice",
    "ProcessInvoice",
    "ProcessShipment",
    "ProcessReceiptAdvice",
    "ProcessPurchaseOrder",
    "ChangePurchaseOrder",
    "CancelPurchaseOrder",
    "CreditNote"
]

Prefer:
Prefer is an optional header. If the Prefer header is specified with the value respond-async, the service will process the request asynchronously. If the Prefer header is not included, the response will be handled synchronously.
Example:
```
respond-async
```
SenderID(required):

This is the ID of the party that's sending the B2B message; the trading partner ID, for example, ABC Company.
SenderIDType(required):
This is the type of ID of the party that's sending the B2B message; the trading partner ID type, for example, Name.
Example:
```
[
    "Generic",
    "DUNS",
    "Direct",
    "GLN",
    "MISC",
    "NetworkID",
    "Name",
    "PHONE",
    "TAXID"
]
```

Supported Media Types

application/xml

Root Schema : schema

Type: object

Show Source

ApplicationArea: object ApplicationArea
DataArea: object DataArea

{
    "x-swagger-router-model":"String",
    "xml":{
        "name":"ProcessInvoice",
        "namespace":"http://www.openapplications.org/oagis/10"
    },
    "properties":{
        "ApplicationArea":{
            "type":"object",
            "xml":{
                "namespace":"http://www.openapplications.org/oagis/10"
            },
            "properties":{
                "Sender":{
                    "type":"object",
                    "properties":{
                        "LogicalID":{
                            "type":"string",
                            "description":"Sender logical ID",
                            "example":"IND_BOD_TP",
                            "xml":{
                                "name":"LogicalID"
                            }
                        }
                    }
                },
                "Receiver":{
                    "type":"object",
                    "properties":{
                        "LogicalID":{
                            "type":"string",
                            "example":"",
                            "description":"Sender logical ID"
                        }
                    }
                },
                "CreationDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Date and time of creation",
                    "example":"2017-03-01T00:00:00.000Z"
                },
                "BODID":{
                    "type":"string",
                    "description":"Business Object Document ID",
                    "example":"EXT_MSG_ID"
                }
            }
        },
        "DataArea":{
            "type":"object",
            "xml":{
                "namespace":"http://www.openapplications.org/oagis/10"
            },
            "properties":{
                "Process":{
                    "type":"object"
                },
                "Invoice":{
                    "type":"object",
                    "properties":{
                        "InvoiceHeader":{
                            "type":"object",
                            "properties":{
                                "ID":{
                                    "type":"string",
                                    "description":"Invoice ID",
                                    "example":"PZ1"
                                },
                                "DocumentDateTime":{
                                    "type":"string",
                                    "format":"date-time",
                                    "description":"Document date and time",
                                    "example":"2017-03-01T00:00:00.000Z"
                                },
                                "TotalAmount":{
                                    "type":"number",
                                    "description":"Total invoice amount",
                                    "example":"50"
                                },
                                "ShipToParty":{
                                    "type":"object",
                                    "properties":{
                                        "Location":{
                                            "type":"object",
                                            "properties":{
                                                "ID":{
                                                    "type":"string",
                                                    "description":"Ship to location ID (e.g., 'GE-PM_HQ')",
                                                    "example":"GE-PM_HQ"
                                                }
                                            }
                                        }
                                    }
                                },
                                "Extension":{
                                    "type":"object",
                                    "properties":{
                                        "ValueText":{
                                            "type":"string",
                                            "example":"One-Time"
                                        },
                                        "typeCode":{
                                            "type":"string",
                                            "example":"DFF",
                                            "xml":{
                                                "attribute":true
                                            }
                                        }
                                    }
                                }
                            }
                        },
                        "InvoiceLine":{
                            "type":"object",
                            "properties":{
                                "Quantity":{
                                    "type":"number",
                                    "description":"Quantity of the item",
                                    "example":"1"
                                },
                                "UnitPrice":{
                                    "type":"object",
                                    "properties":{
                                        "UnitAmount":{
                                            "type":"number",
                                            "description":"Price per unit",
                                            "example":"50"
                                        }
                                    }
                                },
                                "PurchaseOrderReference":{
                                    "type":"object",
                                    "properties":{
                                        "ID":{
                                            "type":"string",
                                            "description":"Purchase order reference ID",
                                            "example":"1002531"
                                        },
                                        "LineNumberID":{
                                            "type":"string",
                                            "description":"Line number ID",
                                            "example":"1"
                                        },
                                        "LineIDSet":{
                                            "type":"object",
                                            "properties":{
                                                "ID":{
                                                    "type":"string",
                                                    "description":"Line ID",
                                                    "example":"4"
                                                }
                                            }
                                        }
                                    }
                                },
                                "ExtendedAmount":{
                                    "type":"number",
                                    "description":"Extended amount for the line",
                                    "example":"61.5"
                                },
                                "TotalAmount":{
                                    "type":"number",
                                    "description":"Total amount for the invoice line",
                                    "example":"61.5"
                                },
                                "InvoiceCharge":{
                                    "type":"object",
                                    "properties":{
                                        "Amount":{
                                            "type":"number",
                                            "description":"Charge amount",
                                            "example":"11.5"
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "type":"object"
}

Nested Schema : ApplicationArea

Type: object

Show Source

BODID: string

Business Object Document ID

Example: EXT_MSG_ID
CreationDateTime: string (date-time)

Date and time of creation

Example: 2017-03-01T00:00:00.000Z
Receiver: object Receiver
Sender: object Sender

{
    "type":"object",
    "xml":{
        "namespace":"http://www.openapplications.org/oagis/10"
    },
    "properties":{
        "Sender":{
            "type":"object",
            "properties":{
                "LogicalID":{
                    "type":"string",
                    "description":"Sender logical ID",
                    "example":"IND_BOD_TP",
                    "xml":{
                        "name":"LogicalID"
                    }
                }
            }
        },
        "Receiver":{
            "type":"object",
            "properties":{
                "LogicalID":{
                    "type":"string",
                    "example":"",
                    "description":"Sender logical ID"
                }
            }
        },
        "CreationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time of creation",
            "example":"2017-03-01T00:00:00.000Z"
        },
        "BODID":{
            "type":"string",
            "description":"Business Object Document ID",
            "example":"EXT_MSG_ID"
        }
    }
}

Nested Schema : DataArea

Type: object

Show Source

Invoice: object Invoice
Process: object Process

{
    "type":"object",
    "xml":{
        "namespace":"http://www.openapplications.org/oagis/10"
    },
    "properties":{
        "Process":{
            "type":"object"
        },
        "Invoice":{
            "type":"object",
            "properties":{
                "InvoiceHeader":{
                    "type":"object",
                    "properties":{
                        "ID":{
                            "type":"string",
                            "description":"Invoice ID",
                            "example":"PZ1"
                        },
                        "DocumentDateTime":{
                            "type":"string",
                            "format":"date-time",
                            "description":"Document date and time",
                            "example":"2017-03-01T00:00:00.000Z"
                        },
                        "TotalAmount":{
                            "type":"number",
                            "description":"Total invoice amount",
                            "example":"50"
                        },
                        "ShipToParty":{
                            "type":"object",
                            "properties":{
                                "Location":{
                                    "type":"object",
                                    "properties":{
                                        "ID":{
                                            "type":"string",
                                            "description":"Ship to location ID (e.g., 'GE-PM_HQ')",
                                            "example":"GE-PM_HQ"
                                        }
                                    }
                                }
                            }
                        },
                        "Extension":{
                            "type":"object",
                            "properties":{
                                "ValueText":{
                                    "type":"string",
                                    "example":"One-Time"
                                },
                                "typeCode":{
                                    "type":"string",
                                    "example":"DFF",
                                    "xml":{
                                        "attribute":true
                                    }
                                }
                            }
                        }
                    }
                },
                "InvoiceLine":{
                    "type":"object",
                    "properties":{
                        "Quantity":{
                            "type":"number",
                            "description":"Quantity of the item",
                            "example":"1"
                        },
                        "UnitPrice":{
                            "type":"object",
                            "properties":{
                                "UnitAmount":{
                                    "type":"number",
                                    "description":"Price per unit",
                                    "example":"50"
                                }
                            }
                        },
                        "PurchaseOrderReference":{
                            "type":"object",
                            "properties":{
                                "ID":{
                                    "type":"string",
                                    "description":"Purchase order reference ID",
                                    "example":"1002531"
                                },
                                "LineNumberID":{
                                    "type":"string",
                                    "description":"Line number ID",
                                    "example":"1"
                                },
                                "LineIDSet":{
                                    "type":"object",
                                    "properties":{
                                        "ID":{
                                            "type":"string",
                                            "description":"Line ID",
                                            "example":"4"
                                        }
                                    }
                                }
                            }
                        },
                        "ExtendedAmount":{
                            "type":"number",
                            "description":"Extended amount for the line",
                            "example":"61.5"
                        },
                        "TotalAmount":{
                            "type":"number",
                            "description":"Total amount for the invoice line",
                            "example":"61.5"
                        },
                        "InvoiceCharge":{
                            "type":"object",
                            "properties":{
                                "Amount":{
                                    "type":"number",
                                    "description":"Charge amount",
                                    "example":"11.5"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : Receiver

Type: object

Show Source

LogicalID: string

Sender logical ID

Example:

{
    "type":"object",
    "properties":{
        "LogicalID":{
            "type":"string",
            "example":"",
            "description":"Sender logical ID"
        }
    }
}

Nested Schema : Sender

Type: object

Show Source

LogicalID: string

Sender logical ID

Example: IND_BOD_TP

{
    "type":"object",
    "properties":{
        "LogicalID":{
            "type":"string",
            "description":"Sender logical ID",
            "example":"IND_BOD_TP",
            "xml":{
                "name":"LogicalID"
            }
        }
    }
}

Nested Schema : Invoice

Type: object

Show Source

InvoiceHeader: object InvoiceHeader
InvoiceLine: object InvoiceLine

{
    "type":"object",
    "properties":{
        "InvoiceHeader":{
            "type":"object",
            "properties":{
                "ID":{
                    "type":"string",
                    "description":"Invoice ID",
                    "example":"PZ1"
                },
                "DocumentDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Document date and time",
                    "example":"2017-03-01T00:00:00.000Z"
                },
                "TotalAmount":{
                    "type":"number",
                    "description":"Total invoice amount",
                    "example":"50"
                },
                "ShipToParty":{
                    "type":"object",
                    "properties":{
                        "Location":{
                            "type":"object",
                            "properties":{
                                "ID":{
                                    "type":"string",
                                    "description":"Ship to location ID (e.g., 'GE-PM_HQ')",
                                    "example":"GE-PM_HQ"
                                }
                            }
                        }
                    }
                },
                "Extension":{
                    "type":"object",
                    "properties":{
                        "ValueText":{
                            "type":"string",
                            "example":"One-Time"
                        },
                        "typeCode":{
                            "type":"string",
                            "example":"DFF",
                            "xml":{
                                "attribute":true
                            }
                        }
                    }
                }
            }
        },
        "InvoiceLine":{
            "type":"object",
            "properties":{
                "Quantity":{
                    "type":"number",
                    "description":"Quantity of the item",
                    "example":"1"
                },
                "UnitPrice":{
                    "type":"object",
                    "properties":{
                        "UnitAmount":{
                            "type":"number",
                            "description":"Price per unit",
                            "example":"50"
                        }
                    }
                },
                "PurchaseOrderReference":{
                    "type":"object",
                    "properties":{
                        "ID":{
                            "type":"string",
                            "description":"Purchase order reference ID",
                            "example":"1002531"
                        },
                        "LineNumberID":{
                            "type":"string",
                            "description":"Line number ID",
                            "example":"1"
                        },
                        "LineIDSet":{
                            "type":"object",
                            "properties":{
                                "ID":{
                                    "type":"string",
                                    "description":"Line ID",
                                    "example":"4"
                                }
                            }
                        }
                    }
                },
                "ExtendedAmount":{
                    "type":"number",
                    "description":"Extended amount for the line",
                    "example":"61.5"
                },
                "TotalAmount":{
                    "type":"number",
                    "description":"Total amount for the invoice line",
                    "example":"61.5"
                },
                "InvoiceCharge":{
                    "type":"object",
                    "properties":{
                        "Amount":{
                            "type":"number",
                            "description":"Charge amount",
                            "example":"11.5"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : Process

Type: object

Nested Schema : InvoiceHeader

Type: object

Show Source

DocumentDateTime: string (date-time)

Document date and time

Example: 2017-03-01T00:00:00.000Z
Extension: object Extension
ID: string

Invoice ID

Example: PZ1
ShipToParty: object ShipToParty
TotalAmount: number

Total invoice amount

Example: 50

{
    "type":"object",
    "properties":{
        "ID":{
            "type":"string",
            "description":"Invoice ID",
            "example":"PZ1"
        },
        "DocumentDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Document date and time",
            "example":"2017-03-01T00:00:00.000Z"
        },
        "TotalAmount":{
            "type":"number",
            "description":"Total invoice amount",
            "example":"50"
        },
        "ShipToParty":{
            "type":"object",
            "properties":{
                "Location":{
                    "type":"object",
                    "properties":{
                        "ID":{
                            "type":"string",
                            "description":"Ship to location ID (e.g., 'GE-PM_HQ')",
                            "example":"GE-PM_HQ"
                        }
                    }
                }
            }
        },
        "Extension":{
            "type":"object",
            "properties":{
                "ValueText":{
                    "type":"string",
                    "example":"One-Time"
                },
                "typeCode":{
                    "type":"string",
                    "example":"DFF",
                    "xml":{
                        "attribute":true
                    }
                }
            }
        }
    }
}

Nested Schema : InvoiceLine

Type: object

Show Source

ExtendedAmount: number

Extended amount for the line

Example: 61.5
InvoiceCharge: object InvoiceCharge
PurchaseOrderReference: object PurchaseOrderReference
Quantity: number

Quantity of the item

Example: 1
TotalAmount: number

Total amount for the invoice line

Example: 61.5
UnitPrice: object UnitPrice

{
    "type":"object",
    "properties":{
        "Quantity":{
            "type":"number",
            "description":"Quantity of the item",
            "example":"1"
        },
        "UnitPrice":{
            "type":"object",
            "properties":{
                "UnitAmount":{
                    "type":"number",
                    "description":"Price per unit",
                    "example":"50"
                }
            }
        },
        "PurchaseOrderReference":{
            "type":"object",
            "properties":{
                "ID":{
                    "type":"string",
                    "description":"Purchase order reference ID",
                    "example":"1002531"
                },
                "LineNumberID":{
                    "type":"string",
                    "description":"Line number ID",
                    "example":"1"
                },
                "LineIDSet":{
                    "type":"object",
                    "properties":{
                        "ID":{
                            "type":"string",
                            "description":"Line ID",
                            "example":"4"
                        }
                    }
                }
            }
        },
        "ExtendedAmount":{
            "type":"number",
            "description":"Extended amount for the line",
            "example":"61.5"
        },
        "TotalAmount":{
            "type":"number",
            "description":"Total amount for the invoice line",
            "example":"61.5"
        },
        "InvoiceCharge":{
            "type":"object",
            "properties":{
                "Amount":{
                    "type":"number",
                    "description":"Charge amount",
                    "example":"11.5"
                }
            }
        }
    }
}

Nested Schema : Extension

Type: object

Show Source

typeCode: string

Example: DFF
ValueText: string

Example: One-Time

{
    "type":"object",
    "properties":{
        "ValueText":{
            "type":"string",
            "example":"One-Time"
        },
        "typeCode":{
            "type":"string",
            "example":"DFF",
            "xml":{
                "attribute":true
            }
        }
    }
}

Nested Schema : ShipToParty

Type: object

Show Source

Location: object Location

{
    "type":"object",
    "properties":{
        "Location":{
            "type":"object",
            "properties":{
                "ID":{
                    "type":"string",
                    "description":"Ship to location ID (e.g., 'GE-PM_HQ')",
                    "example":"GE-PM_HQ"
                }
            }
        }
    }
}

Nested Schema : Location

Type: object

Show Source

ID: string

Ship to location ID (e.g., 'GE-PM_HQ')

Example: GE-PM_HQ

{
    "type":"object",
    "properties":{
        "ID":{
            "type":"string",
            "description":"Ship to location ID (e.g., 'GE-PM_HQ')",
            "example":"GE-PM_HQ"
        }
    }
}

Nested Schema : InvoiceCharge

Type: object

Show Source

Amount: number

Charge amount

Example: 11.5

{
    "type":"object",
    "properties":{
        "Amount":{
            "type":"number",
            "description":"Charge amount",
            "example":"11.5"
        }
    }
}

Nested Schema : PurchaseOrderReference

Type: object

Show Source

ID: string

Purchase order reference ID

Example: 1002531
LineIDSet: object LineIDSet
LineNumberID: string

Line number ID

Example: 1

{
    "type":"object",
    "properties":{
        "ID":{
            "type":"string",
            "description":"Purchase order reference ID",
            "example":"1002531"
        },
        "LineNumberID":{
            "type":"string",
            "description":"Line number ID",
            "example":"1"
        },
        "LineIDSet":{
            "type":"object",
            "properties":{
                "ID":{
                    "type":"string",
                    "description":"Line ID",
                    "example":"4"
                }
            }
        }
    }
}

Nested Schema : UnitPrice

Type: object

Show Source

UnitAmount: number

Price per unit

Example: 50

{
    "type":"object",
    "properties":{
        "UnitAmount":{
            "type":"number",
            "description":"Price per unit",
            "example":"50"
        }
    }
}

Nested Schema : LineIDSet

Type: object

Show Source

ID: string

Line ID

Example: 4

{
    "type":"object",
    "properties":{
        "ID":{
            "type":"string",
            "description":"Line ID",
            "example":"4"
        }
    }
}

Response

Supported Media Types

application/xml

200 Response

Successful Processing

Root Schema : jsonErrorResponse

Type: object

Show Source

error: array error
messageGuid: string

A unique identifier for the message, null if the request failed.
result: string

The result of the operation, indicating either "ERROR" or "SUCCESS".

{
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The result of the operation, indicating either \"ERROR\" or \"SUCCESS\"."
        },
        "messageGuid":{
            "type":"string",
            "description":"A unique identifier for the message, null if the request failed."
        },
        "error":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "detail":{
                        "type":"string",
                        "description":"Detailed error message."
                    }
                }
            }
        }
    },
    "xml":{
        "name":"jsonErrorResponse"
    }
}

Nested Schema : error

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "detail":{
                "type":"string",
                "description":"Detailed error message."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

detail: string

Detailed error message.

{
    "type":"object",
    "properties":{
        "detail":{
            "type":"string",
            "description":"Detailed error message."
        }
    }
}

202 Response

Request has been accepted for processing, but processing has not been completed or may not have started.

Root Schema : jsonErrorResponse

Type: object

Show Source

error: array error
messageGuid: string

A unique identifier for the message, null if the request failed.
result: string

The result of the operation, indicating either "ERROR" or "SUCCESS".

{
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The result of the operation, indicating either \"ERROR\" or \"SUCCESS\"."
        },
        "messageGuid":{
            "type":"string",
            "description":"A unique identifier for the message, null if the request failed."
        },
        "error":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "detail":{
                        "type":"string",
                        "description":"Detailed error message."
                    }
                }
            }
        }
    },
    "xml":{
        "name":"jsonErrorResponse"
    }
}

Nested Schema : error

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "detail":{
                "type":"string",
                "description":"Detailed error message."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

detail: string

Detailed error message.

{
    "type":"object",
    "properties":{
        "detail":{
            "type":"string",
            "description":"Detailed error message."
        }
    }
}

400 Response

Bad Request - Various Error Scenarios

Root Schema : xmlErrorResponse

Type: object

Show Source

error: array error
result: string

The result of the operation, indicating either "ERROR" or "SUCCESS".

{
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The result of the operation, indicating either \"ERROR\" or \"SUCCESS\"."
        },
        "error":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "detail":{
                        "type":"string",
                        "description":"Detailed error message."
                    }
                }
            }
        }
    },
    "xml":{
        "name":"xmlErrorResponse"
    }
}

Nested Schema : error

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "detail":{
                "type":"string",
                "description":"Detailed error message."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

detail: string

Detailed error message.

{
    "type":"object",
    "properties":{
        "detail":{
            "type":"string",
            "description":"Detailed error message."
        }
    }
}

401 Response

Invalid User - Unauthorized

403 Response

User is Not Authorized

415 Response

Unsupported Media Type

500 Response

Internal Server Error

Root Schema : schema

Type: object

Show Source

error: object error
result: string

{
    "type":"object",
    "xml":{
        "name":"response"
    },
    "properties":{
        "result":{
            "type":"string"
        },
        "error":{
            "type":"object",
            "properties":{
                "detail":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : error

Type: object

Show Source

detail: string

{
    "type":"object",
    "properties":{
        "detail":{
            "type":"string"
        }
    }
}