Versions Compared

Old Version 22

changes.mady.by.user Nitin Beri

Saved on

compared with

New Version 23

changes.mady.by.user Akash Kumar Jaiswal

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

You can use the listed APIs on this page to view product information and to manage various activities (Partner, Schema, and Mapping) from an external application. The API provides the way to fetch product information, Create, Update, and Delete activities without accessing the user interface.

...

APIs for Managing Partners

 

OperationMethodAPI EndpointExample Payload
Create PartnerPOST/rest/company
Code Block
titleCreate Partner
collapsetrue
{
	"Company": {
		"name": "Wallgreens",
		"partnerNetworks": [{
			"id": 1
		}
		"primaryContact": "admin@wallgreens.com",
		"phoneNumber": "2025550101",
		"address": "",
		"country": "",
		"status": 200,
		"enableSelfOnboard": false,
		"spokeCompany": false
	}
}

 

 

Update PartnerPUT/rest/company/{partnerId}
Code Block
titleUpdate Partner
collapsetrue
{
	"Company": {
		"name": "Walmart Corporate"
	}
}
Delete PartnerDELETEPUT/rest/company/deletepartner/{partnerId}EMPTY
Update Partner ParametersPUT/rest/company/{partnerId}
Code Block
titleUpdate Partner Parameters
collapsetrue
{
	"Company": {
		"partnerParameter": [{
			"id": "-0",
			"paramId": {
				"id": "11518430417328"
			},
			"value": "Purchase Order"
		},
		{
			"id": "-1",
			"paramId": {
				"id": "11518430417329"
			},
			"value": "c"
		}]
}
Grant all Templates Access to PartnerPOSTrest/templatepartnerlinkage?resourceIdentifier=company
Code Block
titleGrant Access to Partner
collapsetrue
{
	"TemplatePartnerLinkage": {
		"partner": {
			"id": 11535091945351
		}
	}
}
Revoke all Templates Access to PartnerDELETErest/templatepartnerlinkage/{partnerId}

 

?resourceIdentifier=company

EMPTY

Grant a Template Access to PartnerPOST/rest/templatepartnerlinkage?isTemplate=true&resourceIdentifier=transactiontemplate
Code Block
titleGrant Access to Particular Template
collapsetrue
{
	"TemplatePartnerLinkage": {
		"partner": {
			"id": 11535091945351
		},
		"transactionTemplate": {
			"id": 11535091945352
		}
	}
}
Revoke Template Access from PartnerDELETErest/templatepartnerlinkage/ {LinkageIdlinkageId}?isTemplate=true&resourceIdentifier=transactiontemplateEMPTY
Move Partner from One Network to anotherPOST/rest/company/{partnerId}
Code Block
titleChange Partner Network
collapsetrue
{
	"Company": {
		"partnerNetworks": [{
			"id": 1
		}
		]
	}
}
Convert Internal Partner to ExternalPOSTrest/company/enableSelfOnbaord
Code Block
collapsetrue
{
"partnerId" : "11529580510902",
"firstName" : "Walmart",
"lastName" : "Corporation",
"userId" : "Walmart",
"email" : "admin@walmart.com",
"password" : "P@ssw0rd"
}
Convert Internal Partner to External API 2POSTrest/users/import

Multipart Request

ContentType : multipart/form-data

form-data Part1 :

  • name : csvFile
  • value : csv file containing user information

form-data Part2:

  • name : isPartner
  • value : true

 

 

 

...

OperationMethodAPI EndpointExample and Notes
Get all Schema and Mapping activities available to Partner GET /rest/activities/{partnerId}

 By default this endpoint lists all the activities available to partner.

To retrieve specific activities pass the comma separated service name query parameter as below

?services=TextSchema,ExcelSchema

Valid Service Names are

  • TextSchema
  • ExcelSchema
  • AdvanceTextSchema
  • PositionalSchema
  • AdvancePositionalSchema
  • XMLSchema
  • JSONSchema
  • EDISchema
  • DataMapping

By default all the available fields of all activities are returned in response. To limit the number of fields and to get specific fields pass the "fields" query param and pass the comma separated field names as below

?fields=id,entityName


Note:

Only those activities will be returned in response to which the requesting user is authorized to view as per permission settings.

Admin will get all activities.

 

Get all Schema and Mapping activities used by Partner in Transactions of a particular TemplateGET /rest/activities/{partnerId}/{templateId}

By default this endpoint lists all the activities used by partner for a particular template.

To retrieve specific activities pass the comma separated service name query parameter as below

?services=TextSchema,ExcelSchema (See above the list of valid service Names)

 

By default all the available fields of all activities are returned in response. To limit the number of fields and to get specific fields pass the "fields" query param and pass the comma separated field names as below

?fields=id,entityName


 

...