Rel doc - Rel

GET

/customers/{id}/packinglisttemplates/{pltid}

Get a customer packing list template
Success status: 200; ETag response header supplied; Response is cacheable

Params
Response body (Customer.Models.CustomerPackingListTemplate)

Name (* = required)	Data Type	Description
id *	int	CustomerID
pltid *	int	PackingListTemplateID

	Type	Description
TemplateIdentifier	Generic.Models.PackingListTemplateIdentifier	the packing list template id associated with this customer packing list template, used for generating packing list addresses
Name	string
Id	int
LogoUrlOverride	string	if present: overrides logo in Customer.Options.Shipping.PackingListLogoUrl. on GET: url of image; on PUT: url of image -or- {fileExtension}:{base64-encoded image}
FooterUrlOverride	string	if present: overrides footer in Customer.Options.Shipping.PackingListFooterUrl. on GET: url of image; on PUT: url of image -or- {fileExtension}:{base64-encoded image}
ShowShippingNotes	bool	packing list report parameter
Enabled	bool	CustomerPackingListTemplate enabled status
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/orders/packinglistaddresser

Sample accept: application/hal+json

{
  "templateIdentifier": {
    "name": "str",
    "id": 2
  },
  "logoUrlOverride": "str",
  "footerUrlOverride": "str",
  "showShippingNotes": true,
  "enabled": true,
  "rowVersion": "str"
}

PUT

/customers/{id}/packinglisttemplates/{pltid}

Update a customer packing list template
Success status: 200; ETag response header supplied

Name (* = required)	Data Type	Description
id *	int	CustomerID
pltid *	int	PackingListTemplateID

Customer packing list template

	Type	Description
TemplateIdentifier	Generic.Models.PackingListTemplateIdentifier	the packing list template id associated with this customer packing list template, used for generating packing list addresses
Name	string
Id	int
LogoUrlOverride	string	if present: overrides logo in Customer.Options.Shipping.PackingListLogoUrl. on GET: url of image; on PUT: url of image -or- {fileExtension}:{base64-encoded image}
FooterUrlOverride	string	if present: overrides footer in Customer.Options.Shipping.PackingListFooterUrl. on GET: url of image; on PUT: url of image -or- {fileExtension}:{base64-encoded image}
ShowShippingNotes	bool	packing list report parameter
Enabled	bool	CustomerPackingListTemplate enabled status

Sample content-type: application/hal+json

{
  "templateIdentifier": {
    "name": "str",
    "id": 2
  },
  "logoUrlOverride": "str",
  "footerUrlOverride": "str",
  "showShippingNotes": true,
  "enabled": true,
  "rowVersion": "str"
}

	Type	Description
TemplateIdentifier	Generic.Models.PackingListTemplateIdentifier	the packing list template id associated with this customer packing list template, used for generating packing list addresses
Name	string
Id	int
LogoUrlOverride	string	if present: overrides logo in Customer.Options.Shipping.PackingListLogoUrl. on GET: url of image; on PUT: url of image -or- {fileExtension}:{base64-encoded image}
FooterUrlOverride	string	if present: overrides footer in Customer.Options.Shipping.PackingListFooterUrl. on GET: url of image; on PUT: url of image -or- {fileExtension}:{base64-encoded image}
ShowShippingNotes	bool	packing list report parameter
Enabled	bool	CustomerPackingListTemplate enabled status
Links	IList<WebApi.Hal.Link>
	- edit
	- /rels/orders/packinglistaddresser

Sample accept: application/hal+json

{
  "templateIdentifier": {
    "name": "str",
    "id": 2
  },
  "logoUrlOverride": "str",
  "footerUrlOverride": "str",
  "showShippingNotes": true,
  "enabled": true,
  "rowVersion": "str"
}

DELETE

/customers/{id}/packinglisttemplates/{pltid}

Delete a packing list template
If-Match request header required; Success status: 204

Params

Name (* = required)	Data Type	Description
id *	int	CustomerID
pltid *	int	PackingListTemplateID

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.