Rel doc - Rel

GET

/customers/{id}/channels{?resourcetype,includeinactive}

get a list of import channels of a given resource type
Success status: 200

Params
Response body (Customer.Models.ChannelList)

Name (* = required)	Data Type	Description
id *	int	customer id
resourcetype *	Common.Enum.ChannelResourceType
	- Order
	- Receiver
	- Item
includeinactive	bool	default: false

	Type	Description
ResourceList	IList<Customer.Models.Channel>
SkipInvalid	bool	true: create as many as possible; false: all or nothing
ReadOnly	Customer.Models.ChannelReadOnly
ChannelId	int
CreatedDate	DateTime? ...
LastChangedDate	DateTime? ...
CustomerIdentifier	Generic.Models.CustomerIdentifier
ExternalId	string
Name	string
Id	int
CustomerDeactivated	bool
FacilityIdentifier	Generic.Models.FacilityIdentifier
Name	string
Id	int
ResourceType	Common.Enum.ChannelResourceType
	- 0: Order
	- 1: Receiver
	- 2: Item
Provider	string
Name	string
Deactivated	bool	if true, this channel should not be used; either channel or customer is deactivated; see CustomerDeactivated to distinguish
ScheduleCron	string
TransformIdentifier	Generic.Models.TransformIdentifier
Name	string
Id	int
ProviderParams	IEnumerable<Generic.Models.SavedElement>	parameters
Name	string
Value	string

Sample accept: application/hal+json

{
  "_embedded": {
    "http://api.3plCentral.com/rels/customers/channel": [
      {
        "skipInvalid": true,
        "readOnly": {
          "channelId": 1,
          "createdDate": "2016-12-25T23:00:00",
          "lastChangedDate": "2016-12-25T23:00:00",
          "customerIdentifier": {
            "externalId": "str",
            "name": "str",
            "id": 3
          },
          "customerDeactivated": true,
          "facilityIdentifier": {
            "name": "str",
            "id": 2
          },
          "resourceType": 0,
          "provider": "str"
        },
        "name": "str",
        "deactivated": true,
        "scheduleCron": "str",
        "transformIdentifier": {
          "name": "str",
          "id": 2
        },
        "providerParams": [
          {
            "name": "str",
            "value": "str"
          }
        ]
      }
    ]
  }
}

POST

/customers/{id}/channels

Success status: 200; ETag response header supplied

Name (* = required)	Data Type	Description
id *	int

	Type	Description
FacilityIdentifier	Generic.Models.FacilityIdentifier
Name	string
Id	int
ResourceType	Common.Enum.ChannelResourceType
	- 0: Order
	- 1: Receiver
	- 2: Item
Provider	string
SkipInvalid	bool	true: create as many as possible; false: all or nothing
Name	string
Deactivated	bool	if true, this channel should not be used; either channel or customer is deactivated; see CustomerDeactivated to distinguish
ScheduleCron	string
TransformIdentifier	Generic.Models.TransformIdentifier
Name	string
Id	int
ProviderParams	IEnumerable<Generic.Models.SavedElement>	parameters
Name	string
Value	string

Sample content-type: application/hal+json

{
  "facilityIdentifier": {
    "name": "str",
    "id": 2
  },
  "resourceType": 0,
  "provider": "str",
  "skipInvalid": true,
  "name": "str",
  "deactivated": true,
  "scheduleCron": "str",
  "transformIdentifier": {
    "name": "str",
    "id": 2
  },
  "providerParams": [
    {
      "name": "str",
      "value": "str"
    }
  ]
}

	Type	Description
SkipInvalid	bool	true: create as many as possible; false: all or nothing
ReadOnly	Customer.Models.ChannelReadOnly
ChannelId	int
CreatedDate	DateTime? ...
LastChangedDate	DateTime? ...
CustomerIdentifier	Generic.Models.CustomerIdentifier
ExternalId	string
Name	string
Id	int
CustomerDeactivated	bool
FacilityIdentifier	Generic.Models.FacilityIdentifier
Name	string
Id	int
ResourceType	Common.Enum.ChannelResourceType
	- 0: Order
	- 1: Receiver
	- 2: Item
Provider	string
Name	string
Deactivated	bool	if true, this channel should not be used; either channel or customer is deactivated; see CustomerDeactivated to distinguish
ScheduleCron	string
TransformIdentifier	Generic.Models.TransformIdentifier
Name	string
Id	int
ProviderParams	IEnumerable<Generic.Models.SavedElement>	parameters
Name	string
Value	string

Sample accept: application/hal+json

{
  "skipInvalid": true,
  "readOnly": {
    "channelId": 1,
    "createdDate": "2016-12-25T23:00:00",
    "lastChangedDate": "2016-12-25T23:00:00",
    "customerIdentifier": {
      "externalId": "str",
      "name": "str",
      "id": 3
    },
    "customerDeactivated": true,
    "facilityIdentifier": {
      "name": "str",
      "id": 2
    },
    "resourceType": 0,
    "provider": "str"
  },
  "name": "str",
  "deactivated": true,
  "scheduleCron": "str",
  "transformIdentifier": {
    "name": "str",
    "id": 2
  },
  "providerParams": [
    {
      "name": "str",
      "value": "str"
    }
  ]
}

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.