Documentation

Partner Data

• id - unique id assigned to a partner
• sub-domain - custom sub domain that can be used to identify partner by name in the url. https://partner1.squadlocker.com?teamuid=123123
• custom html - custom html that will be displayed in the Squadlocker LMS Module
• locker-create-webhook - an endpoint that exist in the partner’s environment that will be called when a locker is created. or updated. See below for details:

Locker Create Webhook:

When a locker webhook is defined, the following data is returned in JSON format:

• uri: uri of the locker create web hook
• status: stauts of the locker create/update request
• lockerState: the current locker state. i.e., closed, pending, open
• locker_id: record id of the store that was created/edited.
• event: the event that generated the callback
• partner_team_uid: the partners unique identifier passed when the store/locker was created
• open_at: the date the store opens
• created_at: the date the record was created

• locker: additional locker/store data (some of this data is included above)

  id: record id of the locker/store

  team_name: name of the team store

  sport_id: the identifier used by Squadlocker to identify the sport associated with the store/locker

  team_color_id: the identifier used by Squadlocker to identify the color associated with the store/locker

  created_at: the date the locker/store was created

  updated_at: the date the locker/store was last updated

  locker_manager_id: the id in the Squadlocker system that identifies the locker/store manager

  custom_sport_name(depricated): name of sport thats not offered as a choice in Squadlocker system

  team_neutral_color_id(depricated): id of the color that is designated as the neutral color for this locker/store.

  markup: percent items in the store are marked up. This is used for fund raising.

  need_help_with_logo: boolean that determines if the locker/store manager requested help with their logo

  check_recipient_id: the address id that indicates where to send the fund raising check. Internal Squadlocker use.

  approved: indicated if the locker/store has been approved

  lck: INTERNAL SQUADLOCKER USE

  artwork_confirmed: INTERNAL SQUADLOCKER USE

  request_confifirmed: INTERNAL SQUADLOCKER USE

  cancelled: boolean that indicates if a locker/store has been cancelled

  on_boarded_at: INTERNAL SQUADLOCKER USE

  need_help_with_logo_description(depricated): INTERNAL SQUADLOCKER USE

  open_at: date the locker/store opens

  gp_document_id: INTERNAL SQUADLOCKER USE

  discount: discount applied to the locker/store

  disable_emails: boolean used to disable marketing emails

  roster_id: id associated with the team roster

  locker_type: type of locker/store.

  parent_locker_id: id of the locker/store this locker/store was copied from.

  deleted_at: date the locker was soft deleted

  reviewed: INTERNAL SQUADLOCKER USE

Example:

{
	"uri": "http://requestb.in/14aaseg1",
	"status": "success",
	"lockerState": "open",
	"event": "locker-create",
	"data": {
		"locker_id": 2886,
		"partner_team_uid": "some02162017",
		"open_at": "2017-02-16T16:41:09.585-05:00",
		"created_at": "2017-02-16T16:41:09.742-05:00",
		"locker": {
			"id": 2886,
			"team_name": "Callback!",
			"sport_id": 2,
			"team_color_id": 4,
			"created_at": "2017-02-16T16:41:09.630-05:00",
			"updated_at": "2017-02-16T16:41:10.485-05:00",
			"locker_manager_id": 948,
			"custom_sport_name": null,
			"close_at": "2017-03-02T23:59:59.999-05:00",
			"team_neutral_color_ids": ["3"],
			"markup": 0,
			"need_help_with_logo": false,
			"check_recipient_id": null,
			"approved": true,
			"lck": null,
			"artwork_confirmed": false,
			"request_confirmed": false,
			"cancelled": false,
			"on_boarded_at": null,
			"need_help_with_logo_desc": "",
			"open_at": "2017-02-16T16:41:09.585-05:00",
			"gp_document_id": null,
			"discount": 0,
			"disable_emails": false,
			"roster_id": null,
			"locker_type": "temporary",
			"parent_locker_id": null,
			"deleted_at": null,
			"reviewed": false
		}
	}
}