Create an Inbound Agreement
post
/ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs
Creates an inbound agreement for trading partner. The request body must contain atleast name and docId fields.
Request
Supported Media Types
- application/json
Path Parameters
-
tpId(required): string
Trading partner ID.
Create trading partner inbound agreement request.
Example:
{ "name": "inagr", "desc": "inagr desc", "docId":"DOC1", "params":{ "validate":true, "fa":true }, "backendIntgCode": "EDI_INTG", "backendIntgVersion": "01.02.0000"}
Root Schema : InboundAgrRs
Type:
Show Source
object
-
backendIntgCode:
string
-
backendIntgName:
string
-
backendIntgVersion:
string
-
createdDate:
string
-
desc:
string
-
docDef:
string
-
docId:
string
-
docStd:
string
-
docTxId:
string
-
docVersion:
string
-
id:
string
-
lastDeployed:
string
-
links:
array links
-
name:
string
-
params:
object Params
-
status:
string
-
updatedDate:
string
-
warning:
array warning
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : InboundAgrRs
Type:
Show Source
object
-
backendIntgCode:
string
-
backendIntgName:
string
-
backendIntgVersion:
string
-
createdDate:
string
-
desc:
string
-
docDef:
string
-
docId:
string
-
docStd:
string
-
docTxId:
string
-
docVersion:
string
-
id:
string
-
lastDeployed:
string
-
links:
array links
-
name:
string
-
params:
object Params
-
status:
string
-
updatedDate:
string
-
warning:
array warning
201 Response
Successful operation
409 Response
Duplicate data error
412 Response
Pre condition failure
500 Response
Server error