Square Business(독립 게시자)(미리 보기)

Square는 보안 신용 카드 처리에서 판매 솔루션에 이르기까지 수백만 명의 판매자가 비즈니스를 운영하는 데 도움이 됩니다. 이 커넥터에는 로열티, 기프트 카드, Bookings, Business, Team, Financials, Online 및 Auth 엔드포인트에 대한 작업이 포함되어 있습니다.

이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.

서비스	클래스	Regions
Copilot Studio	Premium	다음을 제외한 모든 Power Automate 지역 :      - 미국 정부(GCC)      - 미국 정부(GCC High)      - 21Vianet에서 운영하는 중국 클라우드      - 미국 국방부(DoD)
논리 앱	스탠다드	다음을 제외한 모든 Logic Apps 지역 :      - Azure Government 지역      - Azure 중국 지역      - 미국 국방부(DoD)
Power Apps	Premium	다음을 제외한 모든 Power Apps 지역 :      - 미국 정부(GCC)      - 미국 정부(GCC High)      - 21Vianet에서 운영하는 중국 클라우드      - 미국 국방부(DoD)
Power Automate	Premium	다음을 제외한 모든 Power Automate 지역 :      - 미국 정부(GCC)      - 미국 정부(GCC High)      - 21Vianet에서 운영하는 중국 클라우드      - 미국 국방부(DoD)

연락처
이름	트로이 테일러
URL	https://www.hitachisolutions.com
전자 메일	ttaylor@hitachisolutions.com

커넥터 메타데이터
게시자	트로이 테일러
웹 사이트	https://squareup.com/
개인 정보 보호 정책	https://squareup.com/us/en/legal/general/privacy
카테고리	상업; 판매 및 CRM

제한 한도

Name	호출	갱신 기간
연결당 API 호출	100	60초

동작

GAN(베타)에서 기프트 카드 검색	GAN(기프트 카드 계정 번호)을 사용하여 기프트 카드를 검색합니다.
nonce에서 기프트 카드 검색(베타)	기프트 카드를 나타내는 nonce(보안 토큰)를 사용하여 기프트 카드를 검색합니다.
Shift 만들기	새 Shift를 만듭니다. Shift는 단일 직원의 전체 근무일을 나타냅니다.
Shift 삭제	교대 근무를 삭제합니다.
Upsert 코드 조각	Square Online 사이트에 코드 조각을 추가하거나 사이트의 기존 코드 조각을 업데이트합니다. 코드 조각 코드는 체크 아웃 페이지를 제외한 사이트의 모든 페이지에서 헤드 요소의 끝에 추가됩니다. 코드 조각 애플리케이션은 지정된 사이트에 하나의 코드 조각을 추가할 수 있습니다.
V1 ID로 은행 계좌 가져오기	V1 은행 계좌 ID로 식별된 BankAccount의 세부 정보를 반환합니다.
가맹점 검색	지정된 merchant_id 대한 Merchant 개체를 검색합니다.
가맹점 나열	지정된 액세스 토큰에 대한 가맹점 정보를 반환합니다.
검색 가용성(베타)	예약 가능한지 검색합니다.
검색 교대조	비즈니스에 대해 페이지를 매긴 Shift 레코드 목록을 반환합니다.
교대 근무 가져오기	ID로 지정된 단일 Shift를 반환합니다.
기프트 카드 검색(베타)	ID를 사용하여 기프트 카드를 검색합니다.
기프트 카드 활동 나열(베타)	기프트 카드 활동을 나열합니다. 기본적으로 판매자 계정의 모든 기프트 카드에 대한 기프트 카드 활동을 받을 수 있습니다. 필요에 따라 쿼리 매개 변수를 지정하여 목록을 필터링할 수 있습니다. 예를 들어 기프트 카드, 특정 지역의 모든 기프트 카드 또는 기간 내 활동에 대한 기프트 카드 활동 목록을 가져올 수 있습니다.
기프트 카드 활동 만들기(베타)	기프트 카드 활동을 만듭니다.
기프트 카드에 고객 연결(베타)	고객을 기프트 카드에 연결
기프트 카드에서 고객 연결 해제(베타)	기프트 카드에서 고객 연결을 해제합니다.
디바이스 코드 가져오기	연결된 ID를 사용하여 DeviceCode를 검색합니다.
디바이스 코드 나열	가맹점과 연결된 모든 DeviceCode를 나열합니다.
디바이스 코드 만들기	연결된 터미널 모드로 전환하기 위해 Square 터미널 디바이스에 로그인하는 데 사용할 수 있는 DeviceCode를 만듭니다.
로열티 계정 검색	로열티 계정을 검색합니다.
로열티 계정 검색	로열티 프로그램에서 로열티 계정을 검색합니다.
로열티 계정 만들기	로열티 계정을 만듭니다.
로열티 보상 검색	로열티 보상을 검색합니다.
로열티 보상 검색	로열티 계정에서 로열티 보상을 검색합니다.
로열티 보상 만들기	로열티 보상을 만듭니다. 보상이 생성되면 포인트가 잠기고 구매자가 다른 보상을 사용할 수 없습니다.
로열티 보상 사용	로열티 보상을 사용합니다. 보상이 터미널 상태에 도달하면 삭제할 수 없습니다. 즉, 보상에 사용된 포인트는 계정에 반환할 수 없습니다.
로열티 보상 삭제	로열티 보상을 삭제합니다. 로열티 포인트를 다시 로열티 계정으로 반환합니다. 터미널 상태(REDEEMED)에 도달한 보상은 삭제할 수 없습니다.
로열티 이벤트 검색	충성도 이벤트를 검색합니다. Square 로열티 프로그램은 구매자의 로열티 계정 수명 동안 발생하는 이벤트의 원장을 유지 관리합니다. 포인트 잔액의 각 변경 내용(예: 획득한 포인트, 교환된 포인트 및 만료된 포인트)은 원장에 기록됩니다. 이 엔드포인트를 사용하여 원장에서 이벤트를 검색할 수 있습니다.
로열티 포인트 누적	충성도 계정에 포인트를 추가합니다.
로열티 포인트 조정	구매자의 계정에서 포인트를 추가하거나 뺍니다. 수동으로 점을 조정해야 하는 경우에만 이 엔드포인트를 사용합니다.
로열티 프로그램 검색	프로그램 ID 또는 키워드 기본으로 지정된 판매자 계정의 로열티 프로그램을 검색합니다. 로열티 프로그램은 구매자가 포인트를 획득하고 보상을 위해 포인트를 교환하는 방법을 정의합니다.
모바일 권한 부여 코드 만들기	Square 카드 판독기 연결에 모바일 애플리케이션에 권한을 부여하는 코드를 생성합니다. 권한 부여 코드는 일회성 사용이며 발급 후 60분 후에 만료됩니다.
비즈니스 예약 프로필 검색(베타)	판매자의 예약 프로필을 검색합니다.
사이트 나열	판매자가 속한 Square Online 사이트를 나열합니다.
업데이트 시프트	기존 Shift를 업데이트합니다.
예약 만들기(베타)	예약을 만듭니다.
위치 검색	위치의 세부 정보를 검색합니다. "main"을 위치 ID로 지정하여 주 위치의 세부 정보를 검색할 수 있습니다.
위치 나열	비즈니스의 모든 위치에 대한 정보를 제공합니다.
위치 만들기(베타)	위치를 만듭니다.
위치 업데이트(베타)	위치를 업데이트합니다.
은행 계좌 가져오기	Square 계정에 연결된 BankAccount의 세부 정보를 반환합니다.
은행 계좌 나열	Square 계정에 연결된 BankAccount 개체 목록을 반환합니다.
임금 설정 검색	TeamMember ID로 지정된 팀 구성원에 대한 WageSetting 개체를 검색합니다.
임금 설정 업데이트	WageSetting 개체를 만들거나 업데이트합니다.
작업 주 구성 나열	비즈니스용 WorkweekConfig 인스턴스 목록을 반환합니다.
작업 주 구성 업데이트	WorkweekConfig를 업데이트합니다.
중단 유형 가져오기	ID로 지정된 단일 BreakType을 반환합니다.
중단 유형 나열	비즈니스에 대한 BreakType 인스턴스의 페이지를 매긴 목록을 반환합니다.
중단 유형 만들기	새 BreakType을 만듭니다. BreakType은 Break 개체를 만들기 위한 템플릿입니다.
중단 유형 삭제	기존 BreakType을 삭제합니다. Shift에서 BreakType을 참조하는 경우에도 BreakType을 삭제할 수 있습니다.
중단 유형 업데이트	기존 BreakType을 업데이트합니다.
체크 아웃 만들기	결제 처리 워크플로를 사용하여 결제 정보를 제공하기 위해 고객이 안내하는 checkout_page_url checkoutId를 연결합니다.
충성도 포인트 계산	구매에서 획득한 포인트를 계산합니다. 애플리케이션은 이 엔드포인트를 호출하여 구매자가 특정 구매로 얻을 수 있는 포인트를 표시할 수 있습니다.
코드 조각 검색	Square Online 사이트에서 코드 조각을 검색합니다. 사이트에는 여러 코드 조각 애플리케이션의 코드 조각이 포함될 수 있지만 애플리케이션에서 추가한 코드 조각만 검색할 수 있습니다.
코드 조각 삭제	Square Online 사이트에서 코드 조각을 제거합니다.
팀 구성원 검색	지정된 TeamMember ID에 대한 TeamMember 개체를 검색합니다.
팀 구성원 검색	비즈니스에 대한 TeamMember 개체의 페이지를 매긴 목록을 반환합니다.
팀 구성원 대량 만들기	여러 TeamMember 개체를 만듭니다.
팀 구성원 대량 업데이트	여러 TeamMember 개체를 업데이트합니다.
팀 구성원 만들기	단일 TeamMember 개체를 만듭니다.
팀 구성원 업데이트	단일 TeamMember 개체를 업데이트합니다.
팀 구성원 예약 프로필 나열(베타)	팀 구성원의 예약 프로필을 나열합니다.
팀 구성원 임금 나열	비즈니스에 대한 TeamMemberWage 인스턴스의 페이지를 매긴 목록을 반환합니다.
팀 구성원 임금 받기	ID로 지정된 단일 TeamMemberWage를 반환합니다.
현금 서랍 교대 이벤트 나열	단일 현금 서랍 교대 근무에 대해 페이지를 매긴 이벤트 목록을 제공합니다.
현금 서랍 교대조 검색	단일 현금 서랍 교대 근무에 대한 요약 세부 정보를 제공합니다.
현금 서랍 교대조 나열	날짜 범위의 위치에 대한 모든 현금 서랍 교대조에 대한 세부 정보를 제공합니다.

GAN(베타)에서 기프트 카드 검색

작업 ID:

GiftCardRetrieveGAN

GAN(기프트 카드 계정 번호)을 사용하여 기프트 카드를 검색합니다.

매개 변수

Name	키	필수	형식	Description
GaN	gan		string	기프트 카드 계정 번호입니다.

반환

Name	경로	형식	Description
아이디	gift_card.id	string	Square에서 발급한 고유한 식별자입니다.
유형	gift_card.type	string	이 개체의 형식입니다.
GAN 원본	gift_card.gan_source	string	GAN(기프트 카드 계정 번호)이 Square에서 생성되는지 아니면 사각형이 아닌 시스템에서 가져왔는지 여부를 나타냅니다.
주	gift_card.state	string	현재 상태입니다.
금액	gift_card.balance_money.amount	integer	금액입니다.
통화	gift_card.balance_money.currency	string	통화입니다.
GaN	gift_card.gan	string	기프트 카드 계정 번호입니다.
만든 위치에서	gift_card.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

nonce에서 기프트 카드 검색(베타)

작업 ID:

GiftCardRetrieveNonce

기프트 카드를 나타내는 nonce(보안 토큰)를 사용하여 기프트 카드를 검색합니다.

매개 변수

Name	키	필수	형식	Description
논스(Nonce)	nonce		string	검색할 기프트 카드의 nonce입니다.

반환

Name	경로	형식	Description
아이디	gift_card.id	string	Square에서 발급한 고유한 식별자입니다.
유형	gift_card.type	string	이 개체의 형식입니다.
GAN 원본	gift_card.gan_source	string	GAN(기프트 카드 계정 번호)이 Square에서 생성되는지 아니면 사각형이 아닌 시스템에서 가져왔는지 여부를 나타냅니다.
주	gift_card.state	string	현재 상태입니다.
금액	gift_card.balance_money.amount	integer	금액입니다.
통화	gift_card.balance_money.currency	string	통화입니다.
GaN	gift_card.gan	string	기프트 카드 계정 번호입니다.
만든 위치에서	gift_card.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

Shift 만들기

작업 ID:

LaborCreateShift

새 Shift를 만듭니다. Shift는 단일 직원의 전체 근무일을 나타냅니다.

매개 변수

Name	키	필수	형식	Description
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
팀 구성원 ID	team_member_id		string	팀 구성원의 ID입니다.
위치 ID	location_id		string	위치의 식별자입니다.
시작 날짜	start_at		string	이 개체의 시작 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
종료 기준	end_at		string	RFC 3339; 표준 시간대 + 오프셋으로 이동했습니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
제목	title		string	이 교대 근무 중에 수행된 작업의 이름입니다. 정사각형 노동 보고 UI는 제목별로 교대 근무를 그룹화할 수 있습니다.
금액	amount		integer	금액입니다.
통화	currency		string	통화입니다.
시작 날짜	start_at		string	RFC 3339; 는 Shift와 동일한 표준 시간대 정보를 따릅니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
종료 기준	end_at		string	RFC 3339; 는 Shift와 동일한 표준 시간대 정보를 따릅니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
나누기 형식 ID	break_type_id		string	이 Break가 템플릿으로 지정한 BreakType입니다.
이름	name		string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
예상 기간	expected_duration		string	중단의 예상 길이입니다. 형식: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
지불	is_paid		boolean	이 중단이 보상 목적으로 일한 시간에 대한 계산인지 여부입니다.

반환

Name	경로	형식	Description
아이디	shift.id	string	Square에서 발급한 고유한 식별자입니다.
팀 구성원 ID	shift.team_member_id	string	팀 구성원의 ID입니다.
직원 ID	shift.employee_id	string	Employee의 Square 생성 ID입니다.
위치 ID	shift.location_id	string	위치의 식별자입니다.
Timezone	shift.timezone	string	달력 날짜를 해석하는 데 사용되는 표준 시간대입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
시작 날짜	shift.start_at	string	이 개체의 시작 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
종료 기준	shift.end_at	string	RFC 3339; 표준 시간대 + 오프셋으로 이동했습니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
제목	shift.wage.title	string	이 교대 근무 중에 수행된 작업의 이름입니다. 정사각형 노동 보고 UI는 제목별로 교대 근무를 그룹화할 수 있습니다.
금액	shift.wage.hourly_rate.amount	integer	금액입니다.
통화	shift.wage.hourly_rate.currency	string	통화입니다.
중단 or 휴식	shift.breaks	array of object
아이디	shift.breaks.id	string	개체의 식별자입니다.
시작 날짜	shift.breaks.start_at	string	RFC 3339; 는 Shift와 동일한 표준 시간대 정보를 따릅니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
종료 기준	shift.breaks.end_at	string	RFC 3339; 는 Shift와 동일한 표준 시간대 정보를 따릅니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
나누기 형식 ID	shift.breaks.break_type_id	string	이 Break가 템플릿으로 지정한 BreakType입니다.
이름	shift.breaks.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
예상 기간	shift.breaks.expected_duration	string	중단의 예상 길이입니다. 형식: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
지불	shift.breaks.is_paid	boolean	이 중단이 보상 목적으로 일한 시간에 대한 계산인지 여부입니다.
상태	shift.status	string	이 개체의 현재 확인 상태입니다.
버전	shift.version	integer	이 개체의 현재 버전입니다.
만든 위치에서	shift.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	shift.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

Shift 삭제

작업 ID:

LaborDeleteShift

교대 근무를 삭제합니다.

매개 변수

Name	키	필수	형식	Description
아이디	id	True	string	식별자입니다.

반환

response

object

Upsert 코드 조각

작업 ID:

SnippetUpsert

Square Online 사이트에 코드 조각을 추가하거나 사이트의 기존 코드 조각을 업데이트합니다. 코드 조각 코드는 체크 아웃 페이지를 제외한 사이트의 모든 페이지에서 헤드 요소의 끝에 추가됩니다. 코드 조각 애플리케이션은 지정된 사이트에 하나의 코드 조각을 추가할 수 있습니다.

매개 변수

Name	키	필수	형식	Description
사이트 아이디	site_id	True	string	사이트의 식별자입니다.
Content	content		string	유효한 HTML, JavaScript 또는 둘 다를 포함할 수 있는 코드 조각 코드입니다.

반환

Name	경로	형식	Description
아이디	snippet.id	string	Square에서 발급한 고유한 식별자입니다.
사이트 아이디	snippet.site_id	string	코드 조각이 포함된 사이트의 ID입니다.
Content	snippet.content	string	유효한 HTML, JavaScript 또는 둘 다를 포함할 수 있는 코드 조각 코드입니다.
만든 위치에서	snippet.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	snippet.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

V1 ID로 은행 계좌 가져오기

작업 ID:

BankAccountGetV1

V1 은행 계좌 ID로 식별된 BankAccount의 세부 정보를 반환합니다.

매개 변수

Name	키	필수	형식	Description
V1 은행 계좌 ID	v1_bank_account_id	True	string	원하는 BankAccount의 V1 ID를 연결합니다.

반환

Name	경로	형식	Description
아이디	bank_account.id	string	Square에서 발급한 고유한 식별자입니다.
계정 번호 접미사	bank_account.account_number_suffix	string	계정 번호의 마지막 몇 자리입니다.
국가	bank_account.country	string	ISO 3166 Alpha-2 국가 코드입니다.
통화	bank_account.currency	string	3자 ISO 4217 통화 코드입니다.
계정 유형	bank_account.account_type	string	계정의 유형입니다.
소유자 이름	bank_account.holder_name	string	계정 소유자의 이름입니다.
기본 은행 식별 번호	bank_account.primary_bank_identification_number	string	은행의 기본 식별자입니다.
위치 ID	bank_account.location_id	string	위치의 식별자입니다.
상태	bank_account.status	string	이 개체의 현재 확인 상태입니다.
신용할	bank_account.creditable	boolean	Square에서 이 계정으로 돈을 보낼 수 있는지 여부를 나타냅니다.
직불 가능	bank_account.debitable	boolean	Square가 이 계정에서 돈을 받을 수 있는지 여부를 나타냅니다.
버전	bank_account.version	integer	이 개체의 현재 버전입니다.
은행 이름	bank_account.bank_name	string	실제 금융 기관의 이름입니다.

가맹점 검색

작업 ID:

MerchantRetrieve

지정된 merchant_id 대한 Merchant 개체를 검색합니다.

매개 변수

Name	키	필수	형식	Description
가맹점 ID	merchant_id	True	string	가맹점의 식별자입니다.

반환

Name	경로	형식	Description
아이디	merchant.id	string	Square에서 발급한 고유한 식별자입니다.
비즈니스 이름	merchant.business_name	string	위치의 비즈니스 이름입니다. 이 이름은 해당 위치의 고객에게 표시되는 이름입니다. 예를 들어 이 이름은 고객 영수증에 표시됩니다.
국가	merchant.country	string	ISO 3166 Alpha-2 국가 코드입니다.
언어 코드	merchant.language_code	string	BCP 47 형식의 언어 코드입니다.
통화	merchant.currency	string	3자 ISO 4217 통화 코드입니다.
상태	merchant.status	string	이 개체의 현재 확인 상태입니다.
기본 위치 ID	merchant.main_location_id	string	이 가맹점에 대한 기본 위치의 ID입니다.

가맹점 나열

작업 ID:

MerchantList

지정된 액세스 토큰에 대한 가맹점 정보를 반환합니다.

매개 변수

Name	키	필수	형식	Description
Cursor	cursor		integer	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.

반환

Name	경로	형식	Description
상인	merchant	array of object
아이디	merchant.id	string	Square에서 발급한 고유한 식별자입니다.
비즈니스 이름	merchant.business_name	string	위치의 비즈니스 이름입니다. 이 이름은 해당 위치의 고객에게 표시되는 이름입니다. 예를 들어 이 이름은 고객 영수증에 표시됩니다.
국가	merchant.country	string	ISO 3166 Alpha-2 국가 코드입니다.
언어 코드	merchant.language_code	string	위치와 연결된 언어(BCP 47 형식)입니다.
통화	merchant.currency	string	3자 ISO 4217 통화 코드입니다.
상태	merchant.status	string	이 개체의 현재 확인 상태입니다.
기본 위치 ID	merchant.main_location_id	string	이 가맹점에 대한 기본 위치의 ID입니다.

검색 가용성(베타)

작업 ID:

BookingAvailability

예약 가능한지 검색합니다.

매개 변수

Name	키	필수	형식	Description
시작 날짜	start_at		string	시간 범위가 시작되는 시기를 나타내는 RFC 3339 형식의 날짜/시간 값입니다.
종료 기준	end_at		string	시간 범위가 종료되는 시기를 나타내는 RFC 3339 형식의 날짜/시간 값입니다.
위치 ID	location_id		string	지정된 판매자 위치 ID와 일치하는 가용성을 검색하는 쿼리 식입니다.
서비스 변형 ID	service_variation_id		string	이 세그먼트에서 예약된 서비스를 나타내는 CatalogItemVariation의 ID입니다.
어느 것이든	any		array of string

반환

Name	경로	형식	Description
가용성	availabilities	array of object
시작 날짜	availabilities.start_at	string	사용 가능한 슬롯의 시작 시간을 지정하는 RFC 3339 타임스탬프입니다.
위치 ID	availabilities.location_id	string	위치의 식별자입니다.
약속 세그먼트	availabilities.appointment_segments	array of object
기간 분	availabilities.appointment_segments.duration_minutes	integer	약속 세그먼트의 시간 범위(분)입니다.
팀 구성원 ID	availabilities.appointment_segments.team_member_id	string	이 세그먼트에서 예약한 팀 구성원을 나타내는 TeamMember 개체의 ID입니다.
서비스 변형 ID	availabilities.appointment_segments.service_variation_id	string	이 세그먼트에서 예약된 서비스를 나타내는 CatalogItemVariation 개체의 ID입니다.
서비스 변형 버전	availabilities.appointment_segments.service_variation_version	integer	이 세그먼트에서 예약된 서비스를 나타내는 항목 변형의 현재 버전입니다.
Errors	errors	array of

검색 교대조

작업 ID:

LaborSearchShifts

비즈니스에 대해 페이지를 매긴 Shift 레코드 목록을 반환합니다.

매개 변수

Name	키	필수	형식	Description
시작 날짜	start_date		string	달력 날짜에 대한 ISO 8601 확장 형식당 2017-10-31과 같은 YYYY-MM-DD 형식의 문자열입니다. 날짜 범위의 시작 부분(포함)입니다.
종료 날짜	end_date		string	달력 날짜에 대한 ISO 8601 확장 형식당 2017-10-31과 같은 YYYY-MM-DD 형식의 문자열입니다. 날짜 범위의 끝(포함)입니다.
Shifts By 일치	match_shifts_by		string	날짜가 적용되는 전략입니다.
기본 표준 시간대	default_timezone		string	위치별 표준 시간대는 작업 시간을 날짜/시간 필터로 변환합니다. 쿼리에 포함된 모든 위치에는 표준 시간대가 있어야 합니다. 그렇지 않으면 이 필드를 대체(fallback)로 제공해야 합니다. 형식: 관련 표준 시간대에 대한 IANA 표준 시간대 데이터베이스 식별자입니다.
한계	limit		integer	단일 페이지에서 반환할 결과 수에 대한 제한입니다. 제한은 권고입니다. 구현은 더 많거나 적은 결과를 반환할 수 있습니다. 제공된 제한이 음수, 0 또는 최대 제한인 1,000보다 높은 경우 무시됩니다.

반환

Name	경로	형식	Description
교대 근무	shifts	array of object
아이디	shifts.id	string	Square에서 발급한 고유한 식별자입니다.
팀 구성원 ID	shifts.team_member_id	string	개체와 연결된 팀 구성원에 대한 TeamMember 개체의 ID입니다.
위치 ID	shifts.location_id	string	위치의 식별자입니다.
Timezone	shifts.timezone	string	청구서에서 달력 날짜를 해석하는 데 사용되는 표준 시간대(예: due_date)입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
시작 날짜	shifts.start_at	string	사용 가능한 슬롯의 시작 시간을 지정하는 RFC 3339 타임스탬프입니다.
종료 기준	shifts.end_at	string	RFC 3339; 표준 시간대 + 오프셋으로 이동했습니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
제목	shifts.wage.title	string	이 교대 근무 중에 수행된 작업의 이름입니다. 정사각형 노동 보고 UI는 제목별로 교대 근무를 그룹화할 수 있습니다.
금액	shifts.wage.hourly_rate.amount	integer	금액입니다.
통화	shifts.wage.hourly_rate.currency	string	통화입니다.
중단 or 휴식	shifts.breaks	array of object
아이디	shifts.breaks.id	string	이 개체를 참조할 식별자입니다.
시작 날짜	shifts.breaks.start_at	string	시간 범위가 시작되는 시기를 나타내는 RFC 3339 형식의 날짜/시간 값입니다.
종료 기준	shifts.breaks.end_at	string	시간 범위가 종료되는 시기를 나타내는 RFC 3339 형식의 날짜/시간 값입니다.
나누기 형식 ID	shifts.breaks.break_type_id	string	이 Break가 템플릿으로 지정한 BreakType입니다.
이름	shifts.breaks.name	string	사람이 읽을 수 있는 이름입니다.
예상 기간	shifts.breaks.expected_duration	string	중단의 예상 길이입니다. 형식: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
지불	shifts.breaks.is_paid	boolean	이 중단이 보상 목적으로 일한 시간에 대한 계산인지 여부입니다.
상태	shifts.status	string	이 개체의 현재 확인 상태입니다.
버전	shifts.version	integer	개체의 현재 버전입니다.
만든 위치에서	shifts.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	shifts.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프

교대 근무 가져오기

작업 ID:

LaborGetShift

ID로 지정된 단일 Shift를 반환합니다.

매개 변수

Name	키	필수	형식	Description
아이디	id	True	string	식별자입니다.

반환

Name	경로	형식	Description
아이디	shift.id	string	Square에서 발급한 고유한 식별자입니다.
팀 구성원 ID	shift.team_member_id	string	팀 구성원의 ID입니다.
직원 ID	shift.employee_id	string	Employee의 Square 생성 ID입니다.
위치 ID	shift.location_id	string	위치의 식별자입니다.
Timezone	shift.timezone	string	달력 날짜를 해석하는 데 사용되는 표준 시간대입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
시작 날짜	shift.start_at	string	이 개체의 시작 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
종료 기준	shift.end_at	string	RFC 3339; 표준 시간대 + 오프셋으로 이동했습니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
제목	shift.wage.title	string	이 교대 근무 중에 수행된 작업의 이름입니다. 정사각형 노동 보고 UI는 제목별로 교대 근무를 그룹화할 수 있습니다.
금액	shift.wage.hourly_rate.amount	integer	금액입니다.
통화	shift.wage.hourly_rate.currency	string	통화입니다.
중단 or 휴식	shift.breaks	array of object
아이디	shift.breaks.id	string	개체의 식별자입니다.
시작 날짜	shift.breaks.start_at	string	RFC 3339; 는 Shift와 동일한 표준 시간대 정보를 따릅니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
종료 기준	shift.breaks.end_at	string	RFC 3339; 는 Shift와 동일한 표준 시간대 정보를 따릅니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
나누기 형식 ID	shift.breaks.break_type_id	string	이 Break가 템플릿으로 지정한 BreakType입니다.
이름	shift.breaks.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
예상 기간	shift.breaks.expected_duration	string	중단의 예상 길이입니다. 형식: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
지불	shift.breaks.is_paid	boolean	이 중단이 보상 목적으로 일한 시간에 대한 계산인지 여부입니다.
상태	shift.status	string	이 개체의 현재 확인 상태입니다.
버전	shift.version	integer	이 개체의 현재 버전입니다.
만든 위치에서	shift.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	shift.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

기프트 카드 검색(베타)

작업 ID:

GiftCardRetrieve

ID를 사용하여 기프트 카드를 검색합니다.

매개 변수

Name	키	필수	형식	Description
아이디	id	True	string	식별자입니다.

반환

Name	경로	형식	Description
아이디	gift_card.id	string	Square에서 발급한 고유한 식별자입니다.
유형	gift_card.type	string	이 개체의 형식입니다.
GAN 원본	gift_card.gan_source	string	GAN(기프트 카드 계정 번호)이 Square에서 생성되는지 아니면 사각형이 아닌 시스템에서 가져왔는지 여부를 나타냅니다.
주	gift_card.state	string	현재 상태입니다.
금액	gift_card.balance_money.amount	integer	금액입니다.
통화	gift_card.balance_money.currency	string	통화입니다.
GaN	gift_card.gan	string	기프트 카드 계정 번호입니다.
만든 위치에서	gift_card.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

기프트 카드 활동 나열(베타)

작업 ID:

GiftCardList

기프트 카드 활동을 나열합니다. 기본적으로 판매자 계정의 모든 기프트 카드에 대한 기프트 카드 활동을 받을 수 있습니다. 필요에 따라 쿼리 매개 변수를 지정하여 목록을 필터링할 수 있습니다. 예를 들어 기프트 카드, 특정 지역의 모든 기프트 카드 또는 기간 내 활동에 대한 기프트 카드 활동 목록을 가져올 수 있습니다.

매개 변수

Name	키	필수	형식	Description
기프트 카드 ID	gift_card_id		string	기프트 카드 ID를 제공하는 경우 엔드포인트는 지정된 기프트 카드에 속한 활동을 반환합니다. 그렇지 않으면 엔드포인트는 판매자에 대한 모든 기프트 카드 활동을 반환합니다.
유형	type		string	형식을 제공하는 경우 엔드포인트는 이 유형의 기프트 카드 활동을 반환합니다. 그렇지 않으면 엔드포인트는 모든 유형의 기프트 카드 활동을 반환합니다.
위치 ID	location_id		string	이 선택적 필터를 지정하여 특정 위치에 속하는 레코드만 검색할 수 있습니다.
시작 시간	begin_time		string	opened_at 쿼리의 포괄 시작 시간(ISO 8601 형식)입니다.
종료 시간	end_time		string	opened_at 쿼리의 전용 종료 날짜(ISO 8601 형식)입니다.
한계	limit		integer	응답에서 반환할 수의 상한입니다.
Cursor	cursor		string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.
정렬 순서	sort_order		string	지정된 순서로 카드를 만든 시점을 기준으로 반환된 목록을 정렬합니다.

반환

Name	경로	형식	Description
기프트 카드 활동	gift_card_activities	array of object
아이디	gift_card_activities.id	string	Square에서 발급한 고유한 식별자입니다.
유형	gift_card_activities.type	string	이 개체의 형식입니다.
위치 ID	gift_card_activities.location_id	string	위치의 식별자입니다.
만든 위치에서	gift_card_activities.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
기프트 카드 ID	gift_card_activities.gift_card_id	string	기프트 카드 ID입니다. GAN이 있는 경우 ID가 필요하지 않습니다.
기프트 카드 GAN	gift_card_activities.gift_card_gan	string	기프트 카드 GAN. gift_card_id 있는 경우 GAN이 필요하지 않습니다.
금액	gift_card_activities.gift_card_balance_money.amount	integer	금액입니다.
통화	gift_card_activities.gift_card_balance_money.currency	string	통화입니다.
금액	gift_card_activities.redeem_activity_details.amount_money.amount	integer	금액입니다.
통화	gift_card_activities.redeem_activity_details.amount_money.currency	string	통화입니다.
금액	gift_card_activities.activate_activity_details.amount_money.amount	integer	금액입니다.
통화	gift_card_activities.activate_activity_details.amount_money.currency	string	통화입니다.
주문 ID	gift_card_activities.activate_activity_details.order_id	string	활동과 연결된 순서의 ID입니다.
품목 UID	gift_card_activities.activate_activity_details.line_item_uid	string	기프트 카드 품목의 line_item_uid 주문입니다.

기프트 카드 활동 만들기(베타)

작업 ID:

GiftCardCreate

기프트 카드 활동을 만듭니다.

매개 변수

Name	키	필수	형식	Description
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
기프트 카드 ID	gift_card_id		string	기프트 카드 ID입니다. GAN이 있는 경우 ID가 필요하지 않습니다.
유형	type		string	이 개체의 형식입니다.
위치 ID	location_id		string	위치의 식별자입니다.
주문 ID	order_id		string	활동과 연결된 순서의 ID입니다.
품목 UID	line_item_uid		string	기프트 카드 품목의 line_item_uid 주문입니다.

반환

Name	경로	형식	Description
아이디	gift_card_activity.id	string	Square에서 발급한 고유한 식별자입니다.
기프트 카드 ID	gift_card_activity.gift_card_id	string	기프트 카드 ID입니다. GAN이 있는 경우 ID가 필요하지 않습니다.
기프트 카드 GAN	gift_card_activity.gift_card_gan	string	기프트 카드 GAN. gift_card_id 있는 경우 GAN이 필요하지 않습니다.
유형	gift_card_activity.type	string	이 개체의 형식입니다.
금액	gift_card_activity.gift_card_balance_money.amount	integer	금액입니다.
통화	gift_card_activity.gift_card_balance_money.currency	string	통화입니다.
위치 ID	gift_card_activity.location_id	string	위치의 식별자입니다.
만든 위치에서	gift_card_activity.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
금액	gift_card_activity.activate_activity_details.amount_money.amount	integer	금액입니다.
통화	gift_card_activity.activate_activity_details.amount_money.currency	string	통화입니다.
주문 ID	gift_card_activity.activate_activity_details.order_id	string	활동과 연결된 순서의 ID입니다.
품목 UID	gift_card_activity.activate_activity_details.line_item_uid	string	기프트 카드 품목의 line_item_uid 주문입니다.

기프트 카드에 고객 연결(베타)

작업 ID:

GiftCardLink

고객을 기프트 카드에 연결

매개 변수

Name	키	필수	형식	Description
기프트 카드 ID	gift_card_id	True	string	기프트 카드의 식별자입니다.
고객 ID	customer_id		string	연결할 고객의 ID입니다.

반환

Name	경로	형식	Description
아이디	gift_card.id	string	Square에서 발급한 고유한 식별자입니다.
유형	gift_card.type	string	이 개체의 형식입니다.
GAN 원본	gift_card.gan_source	string	GAN(기프트 카드 계정 번호)이 Square에서 생성되는지 아니면 사각형이 아닌 시스템에서 가져왔는지 여부를 나타냅니다.
주	gift_card.state	string	현재 상태입니다.
금액	gift_card.balance_money.amount	integer	금액입니다.
통화	gift_card.balance_money.currency	string	통화입니다.
GaN	gift_card.gan	string	기프트 카드 계정 번호입니다.
만든 위치에서	gift_card.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
고객 ID	gift_card.customer_ids	array of string

기프트 카드에서 고객 연결 해제(베타)

작업 ID:

GiftCardUnlink

기프트 카드에서 고객 연결을 해제합니다.

매개 변수

Name	키	필수	형식	Description
기프트 카드 ID	gift_card_id	True	string	기프트 카드의 식별자입니다.
고객 ID	customer_id		string	연결할 고객의 ID입니다.

반환

Name	경로	형식	Description
아이디	gift_card.id	string	Square에서 발급한 고유한 식별자입니다.
유형	gift_card.type	string	이 개체의 형식입니다.
GAN 원본	gift_card.gan_source	string	GAN(기프트 카드 계정 번호)이 Square에서 생성되는지 아니면 사각형이 아닌 시스템에서 가져왔는지 여부를 나타냅니다.
주	gift_card.state	string	현재 상태입니다.
금액	gift_card.balance_money.amount	integer	금액입니다.
통화	gift_card.balance_money.currency	string	통화입니다.
GaN	gift_card.gan	string	기프트 카드 계정 번호입니다.
만든 위치에서	gift_card.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

디바이스 코드 가져오기

작업 ID:

DeviceGet

연결된 ID를 사용하여 DeviceCode를 검색합니다.

매개 변수

Name	키	필수	형식	Description
아이디	id	True	string	식별자입니다.

반환

Name	경로	형식	Description
아이디	device_code.id	string	Square에서 발급한 고유한 식별자입니다.
이름	device_code.name	string	개체의 이름입니다.
코드	device_code.code	string	로그인하는 데 사용할 수 있는 고유 코드입니다.
제품 유형	device_code.product_type	string	디바이스 코드의 대상 제품 유형입니다.
위치 ID	device_code.location_id	string	위치의 식별자입니다.
만든 위치에서	device_code.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
페어링 기준	device_code.pair_by	string	이 DeviceCode가 만료되고 더 이상 로그인되지 않는 경우 RFC 3339 형식의 타임스탬프입니다.
상태	device_code.status	string	이 개체의 현재 확인 상태입니다.
디바이스 ID	device_code.device_id	string	디바이스의 ID입니다.
상태가 변경됨	device_code.status_changed_at	string	이 DeviceCode의 상태가 마지막으로 변경된 경우 RFC 3339 형식의 타임스탬프입니다.

디바이스 코드 나열

작업 ID:

DeviceList

가맹점과 연결된 모든 DeviceCode를 나열합니다.

매개 변수

Name	키	필수	형식	Description
Cursor	cursor		string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.
위치 ID	location_id		string	이 선택적 필터를 지정하여 특정 위치에 속하는 레코드만 검색할 수 있습니다.
제품 유형	product_type		string	지정된 경우 지정된 제품 유형을 대상으로 하는 DeviceCodes만 반환합니다. 비어 있는 경우 모든 제품 유형의 DeviceCode를 반환합니다.
상태	status		string	지정한 경우 지정된 상태와 일치하는 개체만 반환합니다.

반환

Name	경로	형식	Description
디바이스 코드	device_codes	array of object
아이디	device_codes.id	string	Square에서 발급한 고유한 식별자입니다.
이름	device_codes.name	string	개체의 이름입니다.
코드	device_codes.code	string	로그인하는 데 사용할 수 있는 고유 코드입니다.
제품 유형	device_codes.product_type	string	디바이스 코드의 대상 제품 유형입니다.
위치 ID	device_codes.location_id	string	위치의 식별자입니다.
만든 위치에서	device_codes.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
페어링 기준	device_codes.pair_by	string	이 DeviceCode가 만료되고 더 이상 로그인되지 않는 경우 RFC 3339 형식의 타임스탬프입니다.
상태	device_codes.status	string	이 개체의 현재 확인 상태입니다.
디바이스 ID	device_codes.device_id	string	이 코드를 사용한 디바이스의 고유 ID입니다. 디바이스가 페어링될 때 채워집니다.
상태가 변경됨	device_codes.status_changed_at	string	이 DeviceCode의 상태가 마지막으로 변경된 경우 RFC 3339 형식의 타임스탬프입니다.

디바이스 코드 만들기

작업 ID:

DeviceCreate

연결된 터미널 모드로 전환하기 위해 Square 터미널 디바이스에 로그인하는 데 사용할 수 있는 DeviceCode를 만듭니다.

매개 변수

Name	키	필수	형식	Description
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
이름	name		string	개체의 이름입니다.
위치 ID	location_id		string	위치의 식별자입니다.
제품 유형	product_type		string	디바이스 코드의 대상 제품 유형입니다.

반환

Name	경로	형식	Description
아이디	device_code.id	string	Square에서 발급한 고유한 식별자입니다.
이름	device_code.name	string	개체의 이름입니다.
코드	device_code.code	string	로그인하는 데 사용할 수 있는 고유 코드입니다.
제품 유형	device_code.product_type	string	디바이스 코드의 대상 제품 유형입니다.
위치 ID	device_code.location_id	string	위치의 식별자입니다.
만든 위치에서	device_code.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
페어링 기준	device_code.pair_by	string	이 DeviceCode가 만료되고 더 이상 로그인되지 않는 경우 RFC 3339 형식의 타임스탬프입니다.
상태	device_code.status	string	이 개체의 현재 확인 상태입니다.
상태가 변경됨	device_code.status_changed_at	string	이 DeviceCode의 상태가 마지막으로 변경된 경우 RFC 3339 형식의 타임스탬프입니다.

로열티 계정 검색

작업 ID:

LoyaltyRetrieveAccount

로열티 계정을 검색합니다.

매개 변수

Name	키	필수	형식	Description
계정 ID	account_id	True	string	계정의 식별자입니다.

반환

Name	경로	형식	Description
아이디	loyalty_account.id	string	Square에서 발급한 고유한 식별자입니다.
아이디	loyalty_account.mapping.id	string	Square 할당 ID입니다.
전화 번호	loyalty_account.mapping.phone_number	string	받는 사람의 전화 번호입니다.
만든 위치에서	loyalty_account.mapping.created_at	string	만들어진 타임스탬프(RFC 3339 형식)입니다.
프로그램 ID	loyalty_account.program_id	string	프로그램의 Square 할당 ID입니다.
저울	loyalty_account.balance	integer	사용 가능한 잔액입니다.
수명 포인트	loyalty_account.lifetime_points	integer	계정 수명 동안 발생한 총 포인트입니다.
고객 ID	loyalty_account.customer_id	string	고객을 나타내는 이 개체의 ID입니다.
만든 위치에서	loyalty_account.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	loyalty_account.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

로열티 계정 검색

작업 ID:

LoyaltySearchAccounts

로열티 프로그램에서 로열티 계정을 검색합니다.

매개 변수

Name	키	필수	형식	Description
한계	limit		integer	단일 페이지에서 반환할 결과 수에 대한 제한입니다. 제한은 권고입니다. 구현은 더 많거나 적은 결과를 반환할 수 있습니다. 제공된 제한이 음수, 0 또는 최대 제한인 1,000보다 높은 경우 무시됩니다.

반환

Name	경로	형식	Description
로열티 계정	loyalty_accounts	array of object
아이디	loyalty_accounts.id	string	Square에서 발급한 고유한 식별자입니다.
아이디	loyalty_accounts.mapping.id	string	개체의 식별자입니다.
전화 번호	loyalty_accounts.mapping.phone_number	string	받는 사람의 전화 번호입니다.
만든 위치에서	loyalty_accounts.mapping.created_at	string	만들어진 타임스탬프(RFC 3339 형식)입니다.
프로그램 ID	loyalty_accounts.program_id	string	계정이 속한 로열티 프로그램의 Square 할당 ID입니다.
저울	loyalty_accounts.balance	integer	로열티 계정에서 사용 가능한 포인트 잔액입니다.
수명 포인트	loyalty_accounts.lifetime_points	integer	계정 수명 동안 발생한 총 포인트입니다.
고객 ID	loyalty_accounts.customer_id	string	계정과 연결된 고객의 Square 할당 ID입니다.
만든 위치에서	loyalty_accounts.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	loyalty_accounts.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
Cursor	cursor	string	원래 쿼리와 연결된 다음 결과 집합을 검색하기 위해 이 엔드포인트에 대한 후속 호출에 페이지 매김 커서를 포함합니다.

로열티 계정 만들기

작업 ID:

LoyaltyCreateAccount

로열티 계정을 만듭니다.

매개 변수

Name	키	필수	형식	Description
전화 번호	phone_number		string	받는 사람의 전화 번호입니다.
프로그램 ID	program_id		string	프로그램의 Square 할당 ID입니다.
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.

반환

Name	경로	형식	Description
아이디	loyalty_account.id	string	Square에서 발급한 고유한 식별자입니다.
아이디	loyalty_account.mapping.id	string	Square 할당 ID입니다.
전화 번호	loyalty_account.mapping.phone_number	string	받는 사람의 전화 번호입니다.
만든 위치에서	loyalty_account.mapping.created_at	string	만들어진 타임스탬프(RFC 3339 형식)입니다.
프로그램 ID	loyalty_account.program_id	string	프로그램의 Square 할당 ID입니다.
저울	loyalty_account.balance	integer	사용 가능한 잔액입니다.
수명 포인트	loyalty_account.lifetime_points	integer	계정 수명 동안 발생한 총 포인트입니다.
만든 위치에서	loyalty_account.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	loyalty_account.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

로열티 보상 검색

작업 ID:

LoyaltyRetrieveReward

로열티 보상을 검색합니다.

매개 변수

Name	키	필수	형식	Description
보상 ID	reward_id	True	string	보상의 식별자입니다.

반환

Name	경로	형식	Description
아이디	reward.id	string	Square에서 발급한 고유한 식별자입니다.
상태	reward.status	string	이 개체의 현재 확인 상태입니다.
로열티 계정 ID	reward.loyalty_account_id	string	이벤트가 발생한 로열티 계정의 ID입니다.
보상 계층 ID	reward.reward_tier_id	string	보상을 만드는 데 사용되는 보상 계층의 Square 할당 ID입니다.
포인트	reward.points	integer	추가되거나 제거된 지점 수입니다.
만든 위치에서	reward.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	reward.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
사용 시	reward.redeemed_at	string	보상이 사용되었을 때의 타임스탬프(RFC 3339 형식)입니다.

로열티 보상 검색

작업 ID:

LoyaltySearchRewards

로열티 계정에서 로열티 보상을 검색합니다.

매개 변수

Name	키	필수	형식	Description
로열티 계정 ID	loyalty_account_id		string	이벤트가 발생한 로열티 계정의 ID입니다.
한계	limit		integer	단일 페이지에서 반환할 결과 수에 대한 제한입니다. 제한은 권고입니다. 구현은 더 많거나 적은 결과를 반환할 수 있습니다. 제공된 제한이 음수, 0 또는 최대 제한인 1,000보다 높은 경우 무시됩니다.

반환

Name	경로	형식	Description
보상	rewards	array of object
아이디	rewards.id	string	Square에서 발급한 고유한 식별자입니다.
상태	rewards.status	string	이 개체의 현재 확인 상태입니다.
로열티 계정 ID	rewards.loyalty_account_id	string	이벤트가 발생한 로열티 계정의 ID입니다.
보상 계층 ID	rewards.reward_tier_id	string	보상을 만드는 데 사용되는 보상 계층의 Square 할당 ID입니다.
포인트	rewards.points	integer	보상에 사용되는 로열티 포인트 수입니다.
주문 ID	rewards.order_id	string	주문의 ID입니다.
만든 위치에서	rewards.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	rewards.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
사용 시	rewards.redeemed_at	string	보상이 사용되었을 때의 타임스탬프(RFC 3339 형식)입니다.

로열티 보상 만들기

작업 ID:

LoyaltyCreateReward

로열티 보상을 만듭니다. 보상이 생성되면 포인트가 잠기고 구매자가 다른 보상을 사용할 수 없습니다.

매개 변수

Name	키	필수	형식	Description
로열티 계정 ID	loyalty_account_id		string	이벤트가 발생한 로열티 계정의 ID입니다.
보상 계층 ID	reward_tier_id		string	보상을 만드는 데 사용되는 보상 계층의 Square 할당 ID입니다.
주문 ID	order_id		string	주문의 ID입니다.
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.

반환

Name	경로	형식	Description
아이디	reward.id	string	Square에서 발급한 고유한 식별자입니다.
상태	reward.status	string	이 개체의 현재 확인 상태입니다.
로열티 계정 ID	reward.loyalty_account_id	string	이벤트가 발생한 로열티 계정의 ID입니다.
보상 계층 ID	reward.reward_tier_id	string	보상을 만드는 데 사용되는 보상 계층의 Square 할당 ID입니다.
포인트	reward.points	integer	추가되거나 제거된 지점 수입니다.
주문 ID	reward.order_id	string	주문의 ID입니다.
만든 위치에서	reward.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	reward.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

로열티 보상 사용

작업 ID:

LoyaltyRedeemReward

로열티 보상을 사용합니다. 보상이 터미널 상태에 도달하면 삭제할 수 없습니다. 즉, 보상에 사용된 포인트는 계정에 반환할 수 없습니다.

매개 변수

Name	키	필수	형식	Description
보상 ID	reward_id	True	string	보상의 식별자입니다.
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
위치 ID	location_id		string	위치 식별자입니다.

반환

Name	경로	형식	Description
아이디	event.id	string	Square에서 발급한 고유한 식별자입니다.
유형	event.type	string	이 개체의 형식입니다.
만든 위치에서	event.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
로열티 프로그램 ID	event.redeem_reward.loyalty_program_id	string	로열티 프로그램의 ID
보상 ID	event.redeem_reward.reward_id	string	로열티 보상의 Square 할당 ID입니다.
로열티 계정 ID	event.loyalty_account_id	string	이벤트가 발생한 로열티 계정의 ID입니다.
위치 ID	event.location_id	string	위치의 식별자입니다.
출처	event.source	string	원본입니다.

로열티 보상 삭제

작업 ID:

LoyaltyDeleteReward

로열티 보상을 삭제합니다. 로열티 포인트를 다시 로열티 계정으로 반환합니다. 터미널 상태(REDEEMED)에 도달한 보상은 삭제할 수 없습니다.

매개 변수

Name	키	필수	형식	Description
보상 ID	reward_id	True	string	보상의 식별자입니다.

반환

response

object

로열티 이벤트 검색

작업 ID:

LoyaltySearchEvents

충성도 이벤트를 검색합니다. Square 로열티 프로그램은 구매자의 로열티 계정 수명 동안 발생하는 이벤트의 원장을 유지 관리합니다. 포인트 잔액의 각 변경 내용(예: 획득한 포인트, 교환된 포인트 및 만료된 포인트)은 원장에 기록됩니다. 이 엔드포인트를 사용하여 원장에서 이벤트를 검색할 수 있습니다.

매개 변수

Name	키	필수	형식	Description
주문 ID	order_id		string	주문 식별자입니다.
한계	limit		integer	단일 페이지에서 반환할 결과 수에 대한 제한입니다. 제한은 권고입니다. 구현은 더 많거나 적은 결과를 반환할 수 있습니다. 제공된 제한이 음수, 0 또는 최대 제한인 1,000보다 높은 경우 무시됩니다.

반환

Name	경로	형식	Description
Events	events	array of object
아이디	events.id	string	Square에서 발급한 고유한 식별자입니다.
유형	events.type	string	이 개체의 형식입니다.
만든 위치에서	events.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
로열티 프로그램 ID	events.accumulate_points.loyalty_program_id	string	로열티 프로그램의 ID
포인트	events.accumulate_points.points	integer	이벤트에 의해 누적된 포인트 수입니다.
주문 ID	events.accumulate_points.order_id	string	활동과 연결된 순서의 ID입니다.
로열티 계정 ID	events.loyalty_account_id	string	이벤트가 발생한 로열티 계정의 ID입니다.
위치 ID	events.location_id	string	위치의 식별자입니다.
출처	events.source	string	이벤트가 Square Point of Sale에 의해 생성되었는지 여부를 정의합니다.
로열티 프로그램 ID	events.redeem_reward.loyalty_program_id	string	로열티 프로그램의 ID
보상 ID	events.redeem_reward.reward_id	string	상환된 로열티 보상의 ID입니다.
주문 ID	events.redeem_reward.order_id	string	활동과 연결된 순서의 ID입니다.
로열티 프로그램 ID	events.create_reward.loyalty_program_id	string	로열티 프로그램의 ID
보상 ID	events.create_reward.reward_id	string	상환된 로열티 보상의 ID입니다.
포인트	events.create_reward.points	integer	이벤트에 의해 누적된 포인트 수입니다.

로열티 포인트 누적

작업 ID:

LoyaltyAccumulatePoints

충성도 계정에 포인트를 추가합니다.

매개 변수

Name	키	필수	형식	Description
계정 ID	account_id	True	string	계정의 식별자입니다.
주문 ID	order_id		string	주문의 ID입니다.
위치 ID	location_id		string	위치 식별자입니다.
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.

반환

Name	경로	형식	Description
아이디	event.id	string	Square에서 발급한 고유한 식별자입니다.
유형	event.type	string	이 개체의 형식입니다.
만든 위치에서	event.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
로열티 프로그램 ID	event.accumulate_points.loyalty_program_id	string	로열티 프로그램의 ID
포인트	event.accumulate_points.points	integer	이벤트에 의해 누적된 포인트 수입니다.
주문 ID	event.accumulate_points.order_id	string	활동과 연결된 순서의 ID입니다.
로열티 계정 ID	event.loyalty_account_id	string	이벤트가 발생한 로열티 계정의 ID입니다.
위치 ID	event.location_id	string	위치의 식별자입니다.
출처	event.source	string	원본입니다.

로열티 포인트 조정

작업 ID:

LoyaltyAdjustPoints

구매자의 계정에서 포인트를 추가하거나 뺍니다. 수동으로 점을 조정해야 하는 경우에만 이 엔드포인트를 사용합니다.

매개 변수

Name	키	필수	형식	Description
계정 ID	account_id	True	string	계정의 식별자입니다.
포인트	points		integer	추가되거나 제거된 지점 수입니다.
이유	reason		string	이 개체의 이유입니다.
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.

반환

Name	경로	형식	Description
아이디	event.id	string	Square에서 발급한 고유한 식별자입니다.
유형	event.type	string	이 개체의 형식입니다.
만든 위치에서	event.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
로열티 프로그램 ID	event.adjust_points.loyalty_program_id	string	로열티 프로그램의 ID
포인트	event.adjust_points.points	integer	이벤트에 의해 누적된 포인트 수입니다.
이유	event.adjust_points.reason	string	포인트 조정 이유입니다.
로열티 계정 ID	event.loyalty_account_id	string	이벤트가 발생한 로열티 계정의 ID입니다.
출처	event.source	string	원본입니다.

로열티 프로그램 검색

작업 ID:

LoyaltyRetrieveProgram

프로그램 ID 또는 키워드 기본으로 지정된 판매자 계정의 로열티 프로그램을 검색합니다. 로열티 프로그램은 구매자가 포인트를 획득하고 보상을 위해 포인트를 교환하는 방법을 정의합니다.

매개 변수

Name	키	필수	형식	Description
프로그램 ID	program_id	True	string	프로그램의 식별자입니다.

반환

Name	경로	형식	Description
아이디	program.id	string	Square에서 발급한 고유한 식별자입니다.
상태	program.status	string	이 개체의 현재 확인 상태입니다.
보상 계층	program.reward_tiers	array of object
아이디	program.reward_tiers.id	string	개체의 식별자입니다.
포인트	program.reward_tiers.points	integer	이벤트에 의해 누적된 포인트 수입니다.
이름	program.reward_tiers.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
Scope	program.reward_tiers.definition.scope	string	개체가 적용되는 수준을 나타냅니다.
할인 유형	program.reward_tiers.definition.discount_type	string	보상 계층이 제공하는 할인 유형입니다.
할인율	program.reward_tiers.definition.percentage_discount	string	할인의 고정 백분율입니다.
만든 위치에서	program.reward_tiers.created_at	string	만들어진 타임스탬프(RFC 3339 형식)입니다.
오브젝트 ID	program.reward_tiers.pricing_rule_reference.object_id	string	참조된 개체의 ID입니다.
카탈로그 버전	program.reward_tiers.pricing_rule_reference.catalog_version	string	개체의 버전입니다.
1	program.terminology.one	string	점의 단수 단위입니다(예: 1점은 별 1개라고 함).
Other	program.terminology.other	string	점의 복수 단위입니다(예: 10개 점을 별 10개라고 함).
위치 ID	program.location_ids	array of string
만든 위치에서	program.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	program.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
계산 규칙	program.accrual_rules	array of object
Accrual 형식	program.accrual_rules.accrual_type	string	구매자가 포인트를 획득하는 방법을 정의하는 누적 규칙의 유형입니다.
포인트	program.accrual_rules.points	integer	이벤트에 의해 누적된 포인트 수입니다.
금액	program.accrual_rules.spend_amount_money.amount	integer	금액입니다.
제외된 범주 ID	program.accrual_rules.excluded_category_ids	array of string
제외된 항목 변형 ID	program.accrual_rules.excluded_item_variation_ids	array of string

모바일 권한 부여 코드 만들기

작업 ID:

MobileAuthorizationCreate

Square 카드 판독기 연결에 모바일 애플리케이션에 권한을 부여하는 코드를 생성합니다. 권한 부여 코드는 일회성 사용이며 발급 후 60분 후에 만료됩니다.

매개 변수

Name	키	필수	형식	Description
위치 ID	location_id		string	위치 식별자입니다.

반환

Name	경로	형식	Description
권한 부여 코드	authorization_code	string	모바일 애플리케이션 인스턴스를 Square 계정에 연결하는 생성된 권한 부여 코드입니다.
만료 시간	expires_at	string	authorization_code RFC 3339 형식으로 만료되는 타임스탬프입니다.

비즈니스 예약 프로필 검색(베타)

작업 ID:

BookingRetrieveProfile

판매자의 예약 프로필을 검색합니다.

반환

Name	경로	형식	Description
판매자 ID	business_booking_profile.seller_id	string	판매자 API를 사용하여 얻을 수 있는 판매자의 ID입니다.
만든 위치에서	business_booking_profile.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
예약 사용	business_booking_profile.booking_enabled	boolean	판매자가 예약을 위해 열려 있는지 여부를 나타냅니다.
고객 표준 시간대 선택	business_booking_profile.customer_timezone_choice	string	예약에 대한 고객의 표준 시간대 정보 선택. Square 온라인 예약 사이트 및 고객에게 모든 알림은 판매자 위치의 표준 시간대 또는 고객이 예약 시 선택하는 표준 시간대를 사용합니다.
예약 정책	business_booking_profile.booking_policy	string	판매자가 예약 요청(ACCEPT_ALL)을 자동으로 수락할지 여부(REQUIRES_ACCEPTANCE)에 대한 정책입니다.
사용자 취소 허용	business_booking_profile.allow_user_cancel	boolean	고객이 자신의 예약(true)을 취소하거나 예약할 수 있는지 여부(false)를 나타냅니다.
위치 유형	business_booking_profile.business_appointment_settings.location_types	array of string
맞춤 시간	business_booking_profile.business_appointment_settings.alignment_time	string	예약에 대한 서비스 기간의 시간 단위입니다.
최소 예약 티드 시간(초)	business_booking_profile.business_appointment_settings.min_booking_lead_time_seconds	integer	서비스를 예약할 수 있는 최소 리드 시간(초)입니다. 예약은 적어도 예약 시작 시간보다 훨씬 앞서 만들어야 합니다.
최대 예약 리드 타임 초	business_booking_profile.business_appointment_settings.max_booking_lead_time_seconds	integer	서비스를 예약하기 전의 최대 리드 시간(초)입니다. 예약 시작 시간보다 훨씬 앞서 예약을 만들어야 합니다.
모든 팀 구성원 예약 사용	business_booking_profile.business_appointment_settings.any_team_member_booking_enabled	boolean	고객이 사용 가능한 모든 시간 슬롯 중에서 선택할 수 있고 직원 구성원이 자동으로 할당(true)되는지 여부(false)를 지정할 수 있는지 여부를 나타냅니다.
여러 서비스 예약 사용	business_booking_profile.business_appointment_settings.multiple_service_booking_enabled	boolean	고객이 단일 온라인 예약으로 여러 서비스를 예약할 수 있는지 여부를 나타냅니다.
금액	business_booking_profile.business_appointment_settings.cancellation_fee_money.amount	string	통화로 표시된 통화의 가장 작은 교단에 있는 금액입니다.
통화	business_booking_profile.business_appointment_settings.cancellation_fee_money.currency	string	ISO 4217 형식의 통화 형식입니다.
취소 정책	business_booking_profile.business_appointment_settings.cancellation_policy	string	판매자가 채택한 취소 정책입니다.
예약 흐름 직원 선택 건너뛰기	business_booking_profile.business_appointment_settings.skip_booking_flow_staff_selection	boolean	고객에게 할당된 직원 구성원(true)이 있는지 또는 선택한 직원 구성원(false)을 선택할 수 있는지 여부를 나타냅니다.
Errors	errors	array of

사이트 나열

작업 ID:

SiteList

판매자가 속한 Square Online 사이트를 나열합니다.

반환

Name	경로	형식	Description
Sites	sites	array of object
아이디	sites.id	string	Square에서 발급한 고유한 식별자입니다.
사이트 제목	sites.site_title	string	사이트의 제목입니다.
도메인	sites.domain	string	사이트의 도메인(프로토콜 제외)입니다.
게시됨	sites.is_published	boolean	사이트가 게시되었는지 여부를 나타냅니다.
만든 위치에서	sites.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	sites.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프

업데이트 시프트

작업 ID:

LaborUpdateShift

기존 Shift를 업데이트합니다.

매개 변수

Name	키	필수	형식	Description
아이디	id	True	string	식별자입니다.
팀 구성원 ID	team_member_id		string	팀 구성원의 ID입니다.
위치 ID	location_id		string	위치의 식별자입니다.
시작 날짜	start_at		string	이 개체의 시작 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
종료 기준	end_at		string	RFC 3339; 표준 시간대 + 오프셋으로 이동했습니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
제목	title		string	이 교대 근무 중에 수행된 작업의 이름입니다. 정사각형 노동 보고 UI는 제목별로 교대 근무를 그룹화할 수 있습니다.
금액	amount		integer	금액입니다.
통화	currency		string	통화입니다.
아이디	id		string	개체의 식별자입니다.
시작 날짜	start_at		string	RFC 3339; 는 Shift와 동일한 표준 시간대 정보를 따릅니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
종료 기준	end_at		string	RFC 3339; 는 Shift와 동일한 표준 시간대 정보를 따릅니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
나누기 형식 ID	break_type_id		string	이 Break가 템플릿으로 지정한 BreakType입니다.
이름	name		string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
예상 기간	expected_duration		string	중단의 예상 길이입니다. 형식: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
지불	is_paid		boolean	이 중단이 보상 목적으로 일한 시간에 대한 계산인지 여부입니다.
버전	version		integer	이 개체의 현재 버전입니다.

반환

Name	경로	형식	Description
아이디	shift.id	string	Square에서 발급한 고유한 식별자입니다.
팀 구성원 ID	shift.team_member_id	string	팀 구성원의 ID입니다.
직원 ID	shift.employee_id	string	Employee의 Square 생성 ID입니다.
위치 ID	shift.location_id	string	위치의 식별자입니다.
Timezone	shift.timezone	string	달력 날짜를 해석하는 데 사용되는 표준 시간대입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
시작 날짜	shift.start_at	string	이 개체의 시작 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
종료 기준	shift.end_at	string	RFC 3339; 표준 시간대 + 오프셋으로 이동했습니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
제목	shift.wage.title	string	이 교대 근무 중에 수행된 작업의 이름입니다. 정사각형 노동 보고 UI는 제목별로 교대 근무를 그룹화할 수 있습니다.
금액	shift.wage.hourly_rate.amount	integer	금액입니다.
통화	shift.wage.hourly_rate.currency	string	통화입니다.
중단 or 휴식	shift.breaks	array of object
아이디	shift.breaks.id	string	개체의 식별자입니다.
시작 날짜	shift.breaks.start_at	string	RFC 3339; 는 Shift와 동일한 표준 시간대 정보를 따릅니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
종료 기준	shift.breaks.end_at	string	RFC 3339; 는 Shift와 동일한 표준 시간대 정보를 따릅니다. 분까지의 정밀도는 유지됩니다. 초는 잘립니다.
나누기 형식 ID	shift.breaks.break_type_id	string	이 Break가 템플릿으로 지정한 BreakType입니다.
이름	shift.breaks.name	string	항목의 이름입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며, 해당 값은 비어 있지 않아야 하며 길이는 유니코드 코드 포인트입니다.
예상 기간	shift.breaks.expected_duration	string	중단의 예상 길이입니다. 형식: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S.
지불	shift.breaks.is_paid	boolean	이 중단이 보상 목적으로 일한 시간에 대한 계산인지 여부입니다.
상태	shift.status	string	이 개체의 현재 확인 상태입니다.
버전	shift.version	integer	이 개체의 현재 버전입니다.
만든 위치에서	shift.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	shift.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

예약 만들기(베타)

작업 ID:

BookingCreate

예약을 만듭니다.

매개 변수

Name	키	필수	형식	Description
고객 ID	customer_id		string	고객을 나타내는 이 개체의 ID입니다.
시작 날짜	start_at		string	이 개체의 시작 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
위치 ID	location_id		string	위치의 식별자입니다.
기간 분	duration_minutes		integer	약속 세그먼트의 시간 범위(분)입니다.
팀 구성원 ID	team_member_id		string	이 세그먼트에서 예약한 팀 구성원을 나타내는 TeamMember 개체의 ID입니다.
서비스 변형 ID	service_variation_id		string	이 세그먼트에서 예약된 서비스를 나타내는 CatalogItemVariation 개체의 ID입니다.
서비스 변형 버전	service_variation_version		integer	이 세그먼트에서 예약된 서비스를 나타내는 항목 변형의 현재 버전입니다.

반환

Name	경로	형식	Description
아이디	booking.id	string	Square에서 발급한 고유한 식별자입니다.
버전	booking.version	integer	이 개체의 현재 버전입니다.
상태	booking.status	string	이 개체의 현재 확인 상태입니다.
만든 위치에서	booking.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	booking.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
위치 ID	booking.location_id	string	위치의 식별자입니다.
고객 ID	booking.customer_id	string	고객을 나타내는 이 개체의 ID입니다.
고객 참고 사항	booking.customer_note	string	고객이 예약에 대한 메모를 제공할 수 있는 자유 텍스트 필드입니다.
판매자 참고 사항	booking.seller_note	string	판매자가 예약에 대한 메모를 제공할 수 있는 자유 텍스트 필드입니다.
시작 날짜	booking.start_at	string	이 개체의 시작 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
약속 세그먼트	booking.appointment_segments	array of object
기간 분	booking.appointment_segments.duration_minutes	integer	약속 세그먼트의 시간 범위(분)입니다.
서비스 변형 ID	booking.appointment_segments.service_variation_id	string	이 세그먼트에서 예약된 서비스를 나타내는 CatalogItemVariation 개체의 ID입니다.
팀 구성원 ID	booking.appointment_segments.team_member_id	string	이 세그먼트에서 예약한 팀 구성원을 나타내는 TeamMember 개체의 ID입니다.
서비스 변형 버전	booking.appointment_segments.service_variation_version	integer	이 세그먼트에서 예약된 서비스를 나타내는 항목 변형의 현재 버전입니다.
Errors	errors	array of

위치 검색

작업 ID:

LocationRetrieve

위치의 세부 정보를 검색합니다. "main"을 위치 ID로 지정하여 주 위치의 세부 정보를 검색할 수 있습니다.

매개 변수

Name	키	필수	형식	Description
위치 ID	location_id	True	string	위치의 식별자입니다.

반환

Name	경로	형식	Description
아이디	location.id	string	Square에서 발급한 고유한 식별자입니다.
이름	location.name	string	개체의 이름입니다.
주소 줄 1	location.address.address_line_1	string	주소의 첫 번째 줄입니다. address_line 시작하는 필드는 주소의 가장 구체적인 세부 정보(예: 거리 번호, 거리 이름 및 건물 이름)를 제공합니다.
지역	location.address.locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	location.address.administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	location.address.postal_code	string	주소의 우편 번호입니다.
국가	location.address.country	string	주소의 국가(ISO 3166-1-alpha-2 형식)입니다.
Timezone	location.timezone	string	달력 날짜를 해석하는 데 사용되는 표준 시간대입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
역량	location.capabilities	array of string
상태	location.status	string	이 개체의 현재 확인 상태입니다.
만든 위치에서	location.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
가맹점 ID	location.merchant_id	string	판매자의 ID입니다.
국가	location.country	string	ISO 3166 Alpha-2 국가 코드입니다.
언어 코드	location.language_code	string	BCP 47 형식의 언어 코드입니다.
통화	location.currency	string	3자 ISO 4217 통화 코드입니다.
전화 번호	location.phone_number	string	고객 프로필과 연결된 11자리 전화 번호입니다.
비즈니스 이름	location.business_name	string	위치의 비즈니스 이름입니다. 이 이름은 해당 위치의 고객에게 표시되는 이름입니다. 예를 들어 이 이름은 고객 영수증에 표시됩니다.

위치 나열

작업 ID:

LocationList

비즈니스의 모든 위치에 대한 정보를 제공합니다.

반환

Name	경로	형식	Description
위치	locations	array of object
아이디	locations.id	string	Square에서 발급한 고유한 식별자입니다.
이름	locations.name	string	개체의 이름입니다.
주소 줄 1	locations.address.address_line_1	string	주소의 첫 번째 줄입니다.
지역	locations.address.locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	locations.address.administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	locations.address.postal_code	string	주소의 우편 번호입니다.
국가	locations.address.country	string	주소의 국가(ISO 3166-1-alpha-2 형식)입니다.
Timezone	locations.timezone	string	청구서에서 달력 날짜를 해석하는 데 사용되는 표준 시간대(예: due_date)입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
역량	locations.capabilities	array of string
상태	locations.status	string	이 개체의 현재 확인 상태입니다.
만든 위치에서	locations.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
가맹점 ID	locations.merchant_id	string	위치를 소유하는 가맹점의 ID입니다.
국가	locations.country	string	ISO 3166 Alpha-2 국가 코드입니다.
언어 코드	locations.language_code	string	위치와 연결된 언어(BCP 47 형식)입니다.
통화	locations.currency	string	3자 ISO 4217 통화 코드입니다.
전화 번호	locations.phone_number	string	고객 프로필과 연결된 11자리 전화 번호입니다.
비즈니스 이름	locations.business_name	string	위치의 비즈니스 이름입니다. 이 이름은 해당 위치의 고객에게 표시되는 이름입니다. 예를 들어 이 이름은 고객 영수증에 표시됩니다.

위치 만들기(베타)

작업 ID:

LocationCreate

위치를 만듭니다.

매개 변수

Name	키	필수	형식	Description
이름	name		string	개체의 이름입니다.
Description	description		string	설명입니다.
Facebook URL	facebook_url		string	위치의 Facebook 프로필 URL입니다. URL은 'facebook.com/'으로 시작해야 합니다.
주소 줄 1	address_line_1		string	주소의 첫 번째 줄입니다. address_line 시작하는 필드는 주소의 가장 구체적인 세부 정보(예: 거리 번호, 거리 이름 및 건물 이름)를 제공합니다.
행정 구역 수준 1	administrative_district_level_1		string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
지역	locality		string	주소의 도시 또는 마을입니다.
우편 번호	postal_code		string	주소의 우편 번호입니다.

반환

Name	경로	형식	Description
아이디	location.id	string	Square에서 발급한 고유한 식별자입니다.
이름	location.name	string	개체의 이름입니다.
주소 줄 1	location.address.address_line_1	string	주소의 첫 번째 줄입니다. address_line 시작하는 필드는 주소의 가장 구체적인 세부 정보(예: 거리 번호, 거리 이름 및 건물 이름)를 제공합니다.
지역	location.address.locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	location.address.administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	location.address.postal_code	string	주소의 우편 번호입니다.
역량	location.capabilities	array of string
상태	location.status	string	이 개체의 현재 확인 상태입니다.
만든 위치에서	location.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
가맹점 ID	location.merchant_id	string	판매자의 ID입니다.
국가	location.country	string	ISO 3166 Alpha-2 국가 코드입니다.
언어 코드	location.language_code	string	BCP 47 형식의 언어 코드입니다.
통화	location.currency	string	3자 ISO 4217 통화 코드입니다.
유형	location.type	string	이 개체의 형식입니다.
Description	location.description	string	설명입니다.
웹 사이트 URL	location.website_url	string	위치의 웹 사이트 URL입니다.
Twitter 사용자 이름	location.twitter_username	string	'@' 기호가 없는 위치의 Twitter 사용자 이름입니다.
Instagram 사용자 이름	location.instagram_username	string	'@' 기호가 없는 위치의 Instagram 사용자 이름입니다.
위도	location.coordinates.latitude	float	도 단위로 표현된 좌표의 위도입니다.
경도	location.coordinates.longitude	float	도 단위로 표현된 좌표의 경도입니다.
MCC	location.mcc	string	ISO 18245로 표준화된 위치의 MCC(가맹점 범주 코드)입니다. MCC는 해당 위치에서 판매되는 상품 또는 서비스의 종류를 설명합니다.

위치 업데이트(베타)

작업 ID:

LocationUpdate

위치를 업데이트합니다.

매개 변수

Name	키	필수	형식	Description
위치 ID	location_id	True	string	위치의 식별자입니다.
이름	name		string	개체의 이름입니다.
Description	description		string	설명입니다.
Facebook URL	facebook_url		string	위치의 Facebook 프로필 URL입니다. URL은 'facebook.com/'으로 시작해야 합니다.
Twitter 사용자 이름	twitter_username		string	'@' 기호가 없는 위치의 Twitter 사용자 이름입니다.
Instagram 사용자 이름	instagram_username		string	'@' 기호가 없는 위치의 Instagram 사용자 이름입니다.
주소 줄 1	address_line_1		string	주소의 첫 번째 줄입니다. address_line 시작하는 필드는 주소의 가장 구체적인 세부 정보(예: 거리 번호, 거리 이름 및 건물 이름)를 제공합니다.
행정 구역 수준 1	administrative_district_level_1		string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
지역	locality		string	주소의 도시 또는 마을입니다.
우편 번호	postal_code		string	주소의 우편 번호입니다.
요일	day_of_week		string	이 기간의 요일입니다.
현지 시간 시작	start_local_time		string	부분 시간 RFC 3339 형식을 사용하여 현지 시간으로 지정된 업무 시간의 시작 시간입니다.
현지 시간 종료	end_local_time		string	부분 시간 RFC 3339 형식을 사용하여 현지 시간으로 지정된 업무 시간의 종료 시간입니다.

반환

Name	경로	형식	Description
아이디	location.id	string	Square에서 발급한 고유한 식별자입니다.
이름	location.name	string	개체의 이름입니다.
주소 줄 1	location.address.address_line_1	string	주소의 첫 번째 줄입니다. address_line 시작하는 필드는 주소의 가장 구체적인 세부 정보(예: 거리 번호, 거리 이름 및 건물 이름)를 제공합니다.
지역	location.address.locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	location.address.administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	location.address.postal_code	string	주소의 우편 번호입니다.
Timezone	location.timezone	string	달력 날짜를 해석하는 데 사용되는 표준 시간대입니다. 청구서가 만들어지면 이 필드는 판매자 위치에 지정된 표준 시간대로 설정됩니다. 값을 변경할 수 없습니다.
역량	location.capabilities	array of string
상태	location.status	string	이 개체의 현재 확인 상태입니다.
만든 위치에서	location.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
가맹점 ID	location.merchant_id	string	판매자의 ID입니다.
국가	location.country	string	ISO 3166 Alpha-2 국가 코드입니다.
언어 코드	location.language_code	string	BCP 47 형식의 언어 코드입니다.
통화	location.currency	string	3자 ISO 4217 통화 코드입니다.
전화 번호	location.phone_number	string	고객 프로필과 연결된 11자리 전화 번호입니다.
비즈니스 이름	location.business_name	string	위치의 비즈니스 이름입니다. 이 이름은 해당 위치의 고객에게 표시되는 이름입니다. 예를 들어 이 이름은 고객 영수증에 표시됩니다.
유형	location.type	string	이 개체의 형식입니다.
웹 사이트 URL	location.website_url	string	위치의 웹 사이트 URL입니다.
기간	location.business_hours.periods	array of object
요일	location.business_hours.periods.day_of_week	string	이 기간의 요일입니다.
현지 시간 시작	location.business_hours.periods.start_local_time	string	부분 시간 RFC 3339 형식을 사용하여 현지 시간으로 지정된 업무 시간의 시작 시간입니다.
현지 시간 종료	location.business_hours.periods.end_local_time	string	부분 시간 RFC 3339 형식을 사용하여 현지 시간으로 지정된 업무 시간의 종료 시간입니다.
비즈니스 전자 메일	location.business_email	string	위치의 전자 메일입니다. 이 전자 메일은 해당 위치의 고객에게 표시됩니다. 예를 들어 이메일은 고객 영수증에 표시됩니다.
Description	location.description	string	설명입니다.
Twitter 사용자 이름	location.twitter_username	string	'@' 기호가 없는 위치의 Twitter 사용자 이름입니다.
Instagram 사용자 이름	location.instagram_username	string	'@' 기호가 없는 위치의 Instagram 사용자 이름입니다.
위도	location.coordinates.latitude	float	도 단위로 표현된 좌표의 위도입니다.
경도	location.coordinates.longitude	float	도 단위로 표현된 좌표의 경도입니다.
MCC	location.mcc	string	ISO 18245로 표준화된 위치의 MCC(가맹점 범주 코드)입니다. MCC는 해당 위치에서 판매되는 상품 또는 서비스의 종류를 설명합니다.

은행 계좌 가져오기

작업 ID:

BankAccountGet

Square 계정에 연결된 BankAccount의 세부 정보를 반환합니다.

매개 변수

Name	키	필수	형식	Description
은행 계좌 ID	bank_account_id	True	string	원하는 BankAccount의 정사각형 발급 ID입니다.

반환

Name	경로	형식	Description
아이디	bank_account.id	string	Square에서 발급한 고유한 식별자입니다.
계정 번호 접미사	bank_account.account_number_suffix	string	계정 번호의 마지막 몇 자리입니다.
국가	bank_account.country	string	ISO 3166 Alpha-2 국가 코드입니다.
통화	bank_account.currency	string	3자 ISO 4217 통화 코드입니다.
계정 유형	bank_account.account_type	string	계정의 유형입니다.
소유자 이름	bank_account.holder_name	string	계정 소유자의 이름입니다.
기본 은행 식별 번호	bank_account.primary_bank_identification_number	string	은행의 기본 식별자입니다.
위치 ID	bank_account.location_id	string	위치의 식별자입니다.
상태	bank_account.status	string	이 개체의 현재 확인 상태입니다.
신용할	bank_account.creditable	boolean	Square에서 이 계정으로 돈을 보낼 수 있는지 여부를 나타냅니다.
직불 가능	bank_account.debitable	boolean	Square가 이 계정에서 돈을 받을 수 있는지 여부를 나타냅니다.
버전	bank_account.version	integer	이 개체의 현재 버전입니다.
은행 이름	bank_account.bank_name	string	실제 금융 기관의 이름입니다.

은행 계좌 나열

작업 ID:

BankAccountList

Square 계정에 연결된 BankAccount 개체 목록을 반환합니다.

매개 변수

Name	키	필수	형식	Description
Cursor	cursor		string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.
한계	limit		integer	응답에서 반환할 수의 상한입니다.
위치 ID	location_id		string	이 선택적 필터를 지정하여 특정 위치에 속하는 레코드만 검색할 수 있습니다.

반환

Name	경로	형식	Description
은행 계좌	bank_accounts	array of object
아이디	bank_accounts.id	string	Square에서 발급한 고유한 식별자입니다.
계정 번호 접미사	bank_accounts.account_number_suffix	string	계정 번호의 마지막 몇 자리입니다.
국가	bank_accounts.country	string	ISO 3166 Alpha-2 국가 코드입니다.
통화	bank_accounts.currency	string	3자 ISO 4217 통화 코드입니다.
계정 유형	bank_accounts.account_type	string	연결된 은행 계좌의 재무 목적입니다.
소유자 이름	bank_accounts.holder_name	string	계정 소유자의 이름입니다. 이 이름은 대상 은행 계좌 레코드의 이름과 일치해야 합니다.
기본 은행 식별 번호	bank_accounts.primary_bank_identification_number	string	은행의 기본 식별자입니다.
위치 ID	bank_accounts.location_id	string	위치의 식별자입니다.
상태	bank_accounts.status	string	이 개체의 현재 확인 상태입니다.
신용할	bank_accounts.creditable	boolean	Square가 이 은행 계좌로 돈을 보낼 수 있는지 여부를 나타냅니다.
직불 가능	bank_accounts.debitable	boolean	Square가 이 은행 계좌로 돈을 보낼 수 있는지 여부를 나타냅니다.
버전	bank_accounts.version	integer	개체의 현재 버전입니다.
은행 이름	bank_accounts.bank_name	string	실제 금융 기관의 이름입니다.

임금 설정 검색

작업 ID:

TeamRetrieveWage

TeamMember ID로 지정된 팀 구성원에 대한 WageSetting 개체를 검색합니다.

매개 변수

Name	키	필수	형식	Description
팀 구성원 ID	team_member_id	True	string	팀 구성원의 식별자입니다.

반환

Name	경로	형식	Description
팀 구성원 ID	wage_setting.team_member_id	string	팀 구성원의 ID입니다.
작업 할당	wage_setting.job_assignments	array of object
직위	wage_setting.job_assignments.job_title	string	작업의 제목입니다.
급여 유형	wage_setting.job_assignments.pay_type	string	급여 기간의 급여 금액을 계산하는 데 사용되는 작업 할당의 현재 급여 유형입니다.
금액	wage_setting.job_assignments.hourly_rate.amount	integer	금액입니다.
통화	wage_setting.job_assignments.hourly_rate.currency	string	통화입니다.
금액	wage_setting.job_assignments.annual_rate.amount	integer	금액입니다.
통화	wage_setting.job_assignments.annual_rate.currency	string	통화입니다.
주별 시간	wage_setting.job_assignments.weekly_hours	integer	작업에 대한 주당 계획된 시간입니다. 작업 PayType이 SALARY인지 설정합니다.
초과 근무 제외	wage_setting.is_overtime_exempt	boolean	팀원이 판매자 국가의 초과 근무 규칙에서 면제되는지 여부입니다.
버전	wage_setting.version	integer	이 개체의 현재 버전입니다.
만든 위치에서	wage_setting.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	wage_setting.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

임금 설정 업데이트

작업 ID:

TeamUpdateWage

WageSetting 개체를 만들거나 업데이트합니다.

매개 변수

Name	키	필수	형식	Description
팀 구성원 ID	team_member_id	True	string	팀 구성원의 식별자입니다.
초과 근무 제외	is_overtime_exempt		boolean	팀원이 판매자 국가의 초과 근무 규칙에서 면제되는지 여부입니다.
직위	job_title		string	작업의 제목입니다.
급여 유형	pay_type		string	급여 기간의 급여 금액을 계산하는 데 사용되는 작업 할당의 현재 급여 유형입니다.
금액	amount		integer	금액입니다.
통화	currency		string	통화입니다.
주별 시간	weekly_hours		integer	작업에 대한 주당 계획된 시간입니다. 작업 PayType이 SALARY인지 설정합니다.
금액	amount		integer	금액입니다.
통화	currency		string	통화입니다.

반환

Name	경로	형식	Description
팀 구성원 ID	wage_setting.team_member_id	string	팀 구성원의 ID입니다.
작업 할당	wage_setting.job_assignments	array of object
직위	wage_setting.job_assignments.job_title	string	작업의 제목입니다.
급여 유형	wage_setting.job_assignments.pay_type	string	급여 기간의 급여 금액을 계산하는 데 사용되는 작업 할당의 현재 급여 유형입니다.
금액	wage_setting.job_assignments.hourly_rate.amount	integer	금액입니다.
통화	wage_setting.job_assignments.hourly_rate.currency	string	통화입니다.
금액	wage_setting.job_assignments.annual_rate.amount	integer	금액입니다.
통화	wage_setting.job_assignments.annual_rate.currency	string	통화입니다.
주별 시간	wage_setting.job_assignments.weekly_hours	integer	작업에 대한 주당 계획된 시간입니다. 작업 PayType이 SALARY인지 설정합니다.
초과 근무 제외	wage_setting.is_overtime_exempt	boolean	팀원이 판매자 국가의 초과 근무 규칙에서 면제되는지 여부입니다.
버전	wage_setting.version	integer	이 개체의 현재 버전입니다.
만든 위치에서	wage_setting.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	wage_setting.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

작업 주 구성 나열

작업 ID:

LaborListConfigs

비즈니스용 WorkweekConfig 인스턴스 목록을 반환합니다.

매개 변수

Name	키	필수	형식	Description
한계	limit		integer	응답에서 반환할 수의 상한입니다.
Cursor	cursor		string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.

반환

Name	경로	형식	Description
Workweek 구성	workweek_configs	array of object
아이디	workweek_configs.id	string	Square에서 발급한 고유한 식별자입니다.
주 시작	workweek_configs.start_of_week	string	보상 목적으로 비즈니스 주가 끝나는 요일입니다.
현지 시간 시작	workweek_configs.start_of_day_local_time	string	영업 주간이 종료되는 현지 시간입니다. HH:MM 형식의 문자열로 표현됩니다(HH:MM:SS도 허용되지만 초는 잘립니다).
버전	workweek_configs.version	integer	개체의 현재 버전입니다.
만든 위치에서	workweek_configs.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	workweek_configs.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
Cursor	cursor	string	원래 쿼리와 연결된 다음 결과 집합을 검색하기 위해 이 엔드포인트에 대한 후속 호출에 페이지 매김 커서를 포함합니다.

작업 주 구성 업데이트

작업 ID:

LaborUpdateConfig

WorkweekConfig를 업데이트합니다.

매개 변수

Name	키	필수	형식	Description
아이디	id	True	string	식별자입니다.
주 시작	start_of_week		string	보상 목적으로 비즈니스 주가 끝나는 요일입니다.
현지 시간 시작	start_of_day_local_time		string	영업 주간이 종료되는 현지 시간입니다. HH:MM 형식의 문자열로 표현됩니다(HH:MM:SS도 허용되지만 초는 잘립니다).
버전	version		integer	이 개체의 현재 버전입니다.

반환

Name	경로	형식	Description
아이디	workweek_config.id	string	Square에서 발급한 고유한 식별자입니다.
주 시작	workweek_config.start_of_week	string	보상 목적으로 비즈니스 주가 끝나는 요일입니다.
현지 시간 시작	workweek_config.start_of_day_local_time	string	영업 주간이 종료되는 현지 시간입니다. HH:MM 형식의 문자열로 표현됩니다(HH:MM:SS도 허용되지만 초는 잘립니다).
버전	workweek_config.version	integer	이 개체의 현재 버전입니다.
만든 위치에서	workweek_config.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	workweek_config.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

중단 유형 가져오기

작업 ID:

LaborGetBreak

ID로 지정된 단일 BreakType을 반환합니다.

매개 변수

Name	키	필수	형식	Description
아이디	id	True	string	식별자입니다.

반환

Name	경로	형식	Description
아이디	break_type.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	break_type.location_id	string	위치의 식별자입니다.
중단 이름	break_type.break_name	string	이 유형의 중단에 대해 사람이 읽을 수 있는 이름입니다. Square 제품의 직원에게 이름이 표시됩니다.
예상 기간	break_type.expected_duration	string	이 중단의 예상 길이입니다. 형식: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. 분 미만의 정밀도는 잘립니다.
지불	break_type.is_paid	boolean	이 중단이 보상 목적으로 일한 시간에 대한 계산인지 여부입니다.
버전	break_type.version	integer	이 개체의 현재 버전입니다.
만든 위치에서	break_type.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	break_type.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

중단 유형 나열

작업 ID:

LaborListBreak

비즈니스에 대한 BreakType 인스턴스의 페이지를 매긴 목록을 반환합니다.

매개 변수

Name	키	필수	형식	Description
위치 ID	location_id		string	이 선택적 필터를 지정하여 특정 위치에 속하는 레코드만 검색할 수 있습니다.
한계	limit		integer	응답에서 반환할 수의 상한입니다.
Cursor	cursor		string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.

반환

Name	경로	형식	Description
중단 유형	break_types	array of object
아이디	break_types.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	break_types.location_id	string	위치의 식별자입니다.
중단 이름	break_types.break_name	string	이 유형의 중단에 대해 사람이 읽을 수 있는 이름입니다. Square 제품의 직원에게 이름이 표시됩니다.
예상 기간	break_types.expected_duration	string	이 중단의 예상 길이입니다. 형식: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. 분 미만의 정밀도는 잘립니다.
지불	break_types.is_paid	boolean	이 중단이 보상 목적으로 일한 시간에 대한 계산인지 여부입니다.
버전	break_types.version	integer	개체의 현재 버전입니다.
만든 위치에서	break_types.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	break_types.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
Cursor	cursor	string	원래 쿼리와 연결된 다음 결과 집합을 검색하기 위해 이 엔드포인트에 대한 후속 호출에 페이지 매김 커서를 포함합니다.

중단 유형 만들기

작업 ID:

LaborCreateBreak

새 BreakType을 만듭니다. BreakType은 Break 개체를 만들기 위한 템플릿입니다.

매개 변수

Name	키	필수	형식	Description
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
위치 ID	location_id		string	위치의 식별자입니다.
중단 이름	break_name		string	이 유형의 중단에 대해 사람이 읽을 수 있는 이름입니다. Square 제품의 직원에게 이름이 표시됩니다.
예상 기간	expected_duration		string	이 중단의 예상 길이입니다. 형식: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. 분 미만의 정밀도는 잘립니다.
지불	is_paid		boolean	이 중단이 보상 목적으로 일한 시간에 대한 계산인지 여부입니다.

반환

Name	경로	형식	Description
아이디	break_type.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	break_type.location_id	string	위치의 식별자입니다.
중단 이름	break_type.break_name	string	이 유형의 중단에 대해 사람이 읽을 수 있는 이름입니다. Square 제품의 직원에게 이름이 표시됩니다.
예상 기간	break_type.expected_duration	string	이 중단의 예상 길이입니다. 형식: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. 분 미만의 정밀도는 잘립니다.
지불	break_type.is_paid	boolean	이 중단이 보상 목적으로 일한 시간에 대한 계산인지 여부입니다.
버전	break_type.version	integer	이 개체의 현재 버전입니다.
만든 위치에서	break_type.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	break_type.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

중단 유형 삭제

작업 ID:

LaborDeleteBreak

기존 BreakType을 삭제합니다. Shift에서 BreakType을 참조하는 경우에도 BreakType을 삭제할 수 있습니다.

매개 변수

Name	키	필수	형식	Description
아이디	id	True	string	식별자입니다.

반환

response

object

중단 유형 업데이트

작업 ID:

LaborUpdateBreak

기존 BreakType을 업데이트합니다.

매개 변수

Name	키	필수	형식	Description
아이디	id	True	string	식별자입니다.
위치 ID	location_id		string	위치의 식별자입니다.
중단 이름	break_name		string	이 유형의 중단에 대해 사람이 읽을 수 있는 이름입니다. Square 제품의 직원에게 이름이 표시됩니다.
예상 기간	expected_duration		string	이 중단의 예상 길이입니다. 형식: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. 분 미만의 정밀도는 잘립니다.
지불	is_paid		boolean	이 중단이 보상 목적으로 일한 시간에 대한 계산인지 여부입니다.
버전	version		integer	이 개체의 현재 버전입니다.

반환

Name	경로	형식	Description
아이디	break_type.id	string	Square에서 발급한 고유한 식별자입니다.
위치 ID	break_type.location_id	string	위치의 식별자입니다.
중단 이름	break_type.break_name	string	이 유형의 중단에 대해 사람이 읽을 수 있는 이름입니다. Square 제품의 직원에게 이름이 표시됩니다.
예상 기간	break_type.expected_duration	string	이 중단의 예상 길이입니다. 형식: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. 분 미만의 정밀도는 잘립니다.
지불	break_type.is_paid	boolean	이 중단이 보상 목적으로 일한 시간에 대한 계산인지 여부입니다.
버전	break_type.version	integer	이 개체의 현재 버전입니다.
만든 위치에서	break_type.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	break_type.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

체크 아웃 만들기

작업 ID:

CheckoutCreate

결제 처리 워크플로를 사용하여 결제 정보를 제공하기 위해 고객이 안내하는 checkout_page_url checkoutId를 연결합니다.

매개 변수

Name	키	필수	형식	Description
위치 ID	location_id	True	string	위치의 식별자입니다.
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
리디렉션 URL	redirect_url		string	예를 들어 제공된 리디렉션 URL이 있으면 http://www.example.com/order-complete트랜잭션이 성공하면 고객이 다음으로 리디렉션됩니다. http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx 리디렉션 URL을 제공하지 않으면 Square Checkout에서 사용자를 대신하여 주문 확인 페이지를 표시합니다. 그러나 트랜잭션 결과를 확인하고 기존/일반 확인 워크플로를 통해 주문을 완료할 수 있도록 리디렉션 URL을 제공하는 것이 좋습니다.
Idempotency 키	idempotency_key		string	사용자가 만든 주문 중 이 주문을 고유하게 식별하는 값을 지정합니다. 특정 주문이 성공적으로 만들어졌는지 확실하지 않은 경우 중복 주문을 만드는 것에 대해 걱정하지 않고 동일한 idempotency 키로 다시 시도할 수 있습니다.
위치 ID	location_id		string	지정된 판매자 위치 ID와 일치하는 가용성을 검색하는 쿼리 식입니다.
고객 ID	customer_id		string	주문과 연결된 고객의 ID입니다.
참조 ID	reference_id		string	다른 시스템의 엔터티를 이 순서와 연결하는 클라이언트 지정 ID입니다.
이름	name		string	항목의 이름입니다.
수량	quantity		string	구매한 수량으로, 10진수로 형식이 지정됩니다. 수량이 0인 품목은 지불하거나 주문을 완료할 때 자동으로 제거됩니다.
금액	amount		integer	금액입니다.
통화	currency		string	통화입니다.
할인 UID	discount_uid		string	적용된 할인이 나타내는 할인의 UID입니다. order.discounts 필드에 있는 할인을 참조해야 합니다. 이 필드는 변경할 수 없습니다. 품목에 적용되는 할인을 변경하려면 할인을 삭제하고 새 OrderLineItemAppliedDiscount로 다시 추가해야 합니다.
세금 UID	tax_uid		string	이 적용된 세금이 나타내는 세금의 UID입니다. order.tax 필드에 있는 세금을 참조해야 합니다. 이 필드는 변경할 수 없습니다. 품목에 적용되는 세금을 변경하려면 새 OrderLineItemAppliedTax를 삭제하고 추가합니다.
UID	uid		string	고유 ID입니다.
유형	type		string	이 개체의 형식입니다.
백분율	percentage		string	10진수의 문자열 표현인 세금의 백분율입니다.
Scope	scope		string	개체가 적용되는 수준을 나타냅니다.
UID	uid		string	고유 ID입니다.
유형	type		string	이 개체의 형식입니다.
Scope	scope		string	개체가 적용되는 수준을 나타냅니다.
금액	amount		integer	금액입니다.
통화	currency		string	통화입니다.
위치 ID	location_id		string	위치의 식별자입니다.
Description	title		string	설명입니다.
금액	amount		integer	금액입니다.
통화	currency		string	통화입니다.
배송 주소 요청	ask_for_shipping_address		boolean	true이면 Square Checkout은 사용자 대신 배송 정보를 수집하고 해당 정보를 거래 정보와 함께 Square Seller 대시보드에 저장합니다.
가맹점 지원 이메일	merchant_support_email		string	Square 체크 아웃 확인 페이지에 표시할 전자 메일 주소와 구매자가 판매자에게 연락하는 데 사용할 수 있는 확인 전자 메일입니다. 이 값을 설정하지 않으면 확인 페이지와 전자 메일에 판매자의 Square 계정과 연결된 기본 전자 메일 주소가 표시됩니다.
구매자 전자 메일 미리 채우기	pre_populate_buyer_email		string	제공된 경우 구매자의 전자 메일은 체크 아웃 페이지에서 편집 가능한 텍스트 필드로 미리 채워집니다.
주소 줄 1	address_line_1		string	주소의 첫 번째 줄입니다.
주소 줄 2	address_line_2		string	주소의 두 번째 줄(있는 경우)입니다.
지역	locality		string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	administrative_district_level_1		string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	postal_code		string	주소의 우편 번호입니다.
국가	country		string	ISO 3166 Alpha-2 국가 코드입니다.
이름 (First Name)	first_name		string	받는 사람을 나타내는 경우 선택적 이름입니다.
성 이름	last_name		string	받는 사람을 나타내는 경우 선택적 성입니다.

반환

Name	경로	형식	Description
아이디	checkout.id	string	Square에서 발급한 고유한 식별자입니다.
체크 아웃 페이지 URL	checkout.checkout_page_url	string	체크 아웃이 완료된 후 구매자의 브라우저를 리디렉션해야 하는 URL입니다.
배송 주소 요청	checkout.ask_for_shipping_address	boolean	true이면 Square Checkout에서 사용자 대신 배송 정보를 수집하고 해당 정보를 Square 대시보드에 트랜잭션 정보와 함께 저장합니다.
가맹점 지원 이메일	checkout.merchant_support_email	string	Square 체크 아웃 확인 페이지에 표시할 전자 메일 주소와 구매자가 판매자에게 연락하는 데 사용할 수 있는 확인 전자 메일입니다.
구매자 전자 메일 미리 채우기	checkout.pre_populate_buyer_email	string	제공된 경우 구매자의 전자 메일은 체크 아웃 페이지에서 편집 가능한 텍스트 필드로 미리 채워집니다.
주소 줄 1	checkout.pre_populate_shipping_address.address_line_1	string	주소의 첫 번째 줄입니다. address_line 시작하는 필드는 주소의 가장 구체적인 세부 정보(예: 거리 번호, 거리 이름 및 건물 이름)를 제공합니다.
주소 줄 2	checkout.pre_populate_shipping_address.address_line_2	string	주소의 두 번째 줄(있는 경우)입니다.
지역	checkout.pre_populate_shipping_address.locality	string	주소의 도시 또는 마을입니다.
행정 구역 수준 1	checkout.pre_populate_shipping_address.administrative_district_level_1	string	주소 국가 내의 민간 법인입니다. 미국에서는 이것이 상태입니다.
우편 번호	checkout.pre_populate_shipping_address.postal_code	string	주소의 우편 번호입니다.
국가	checkout.pre_populate_shipping_address.country	string	주소의 국가(ISO 3166-1-alpha-2 형식)입니다.
이름 (First Name)	checkout.pre_populate_shipping_address.first_name	string	받는 사람을 나타내는 경우 선택적 이름입니다.
성 이름	checkout.pre_populate_shipping_address.last_name	string	받는 사람을 나타내는 경우 선택적 lsat 이름입니다.
리디렉션 URL	checkout.redirect_url	string	checkoutId, Square의 orderId, transactionId 및 referenceId가 URL 매개 변수로 추가되어 체크 아웃 후 리디렉션할 URL입니다. 예를 들어 제공된 redirect_url http://www.example.com/order-complete경우 트랜잭션이 성공하면 고객이 다음으로 리디렉션됩니다. http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx 리디렉션 URL을 제공하지 않으면 Square Checkout에서 사용자를 대신하여 주문 확인 페이지가 표시됩니다. 그러나 Square는 트랜잭션 결과를 확인하고 기존/일반 확인 워크플로를 통해 주문을 완료할 수 있도록 리디렉션 URL을 제공하는 것이 좋습니다.
위치 ID	checkout.order.location_id	string	지정된 판매자 위치 ID와 일치하는 가용성을 검색하는 쿼리 식입니다.
고객 ID	checkout.order.customer_id	string	주문과 연결된 고객의 ID입니다.
참조 ID	checkout.order.reference_id	string	다른 시스템의 엔터티를 이 순서와 연결하는 클라이언트 지정 ID입니다.
줄 항목	checkout.order.line_items	array of object
이름	checkout.order.line_items.name	string	품목의 이름입니다.
수량	checkout.order.line_items.quantity	string	구매한 수량으로, 10진수로 형식이 지정됩니다. 수량이 0인 품목은 지불하거나 주문을 완료할 때 자동으로 제거됩니다.
적용된 세금	checkout.order.line_items.applied_taxes	array of object
세금 UID	checkout.order.line_items.applied_taxes.tax_uid	string	이 적용된 세금이 나타내는 세금의 UID입니다. order.tax 필드에 있는 세금을 참조해야 합니다. 이 필드는 변경할 수 없습니다. 품목에 적용되는 세금을 변경하려면 새 OrderLineItemAppliedTax를 삭제하고 추가합니다.
금액	checkout.order.line_items.applied_taxes.applied_money.amount	integer	통화로 표시된 통화의 가장 작은 교단에 있는 금액입니다. 예를 들어 통화가 USD인 경우 금액은 센트 단위입니다. 금액은 양수 또는 음수일 수 있습니다. 특정 사례에서 기호의 의미를 확인하려면 특정 필드 설명을 참조하세요.
통화	checkout.order.line_items.applied_taxes.applied_money.currency	string	ISO 4217 형식의 통화 형식입니다. 예를 들어 미국 달러의 통화 코드는 USD입니다.
적용된 할인	checkout.order.line_items.applied_discounts	array of object
할인 UID	checkout.order.line_items.applied_discounts.discount_uid	string	적용된 할인이 나타내는 할인의 UID입니다. order.discounts 필드에 있는 할인을 참조해야 합니다. 이 필드는 변경할 수 없습니다. 품목에 적용되는 할인을 변경하려면 할인을 삭제하고 새 OrderLineItemAppliedDiscount로 다시 추가해야 합니다.
금액	checkout.order.line_items.applied_discounts.applied_money.amount	integer	통화로 표시된 통화의 가장 작은 교단에 있는 금액입니다. 예를 들어 통화가 USD인 경우 금액은 센트 단위입니다. 금액은 양수 또는 음수일 수 있습니다. 특정 사례에서 기호의 의미를 확인하려면 특정 필드 설명을 참조하세요.
통화	checkout.order.line_items.applied_discounts.applied_money.currency	string	ISO 4217 형식의 통화 형식입니다. 예를 들어 미국 달러의 통화 코드는 USD입니다.
금액	checkout.order.line_items.base_price_money.amount	integer	금액입니다.
통화	checkout.order.line_items.base_price_money.currency	string	통화입니다.
금액	checkout.order.line_items.total_tax_money.amount	integer	금액입니다.
통화	checkout.order.line_items.total_tax_money.currency	string	통화입니다.
금액	checkout.order.line_items.total_discount_money.amount	integer	금액입니다.
통화	checkout.order.line_items.total_discount_money.currency	string	통화입니다.
금액	checkout.order.line_items.total_money.amount	integer	금액입니다.
통화	checkout.order.line_items.total_money.currency	string	통화입니다.
세금	checkout.order.taxes	array of object
UID	checkout.order.taxes.uid	string	고유 ID입니다.
유형	checkout.order.taxes.type	string	이 개체의 형식입니다.
백분율	checkout.order.taxes.percentage	string	10진수의 문자열 표현인 세금의 백분율입니다.
Scope	checkout.order.taxes.scope	string	개체가 적용되는 수준을 나타냅니다.
할인	checkout.order.discounts	array of object
UID	checkout.order.discounts.uid	string	고유 ID입니다.
유형	checkout.order.discounts.type	string	이 개체의 형식입니다.
Scope	checkout.order.discounts.scope	string	개체가 적용되는 수준을 나타냅니다.
금액	checkout.order.discounts.amount_money.amount	integer	금액입니다.
통화	checkout.order.discounts.amount_money.currency	string	통화입니다.
금액	checkout.order.discounts.applied_money.amount	integer	금액입니다.
통화	checkout.order.discounts.applied_money.currency	string	통화입니다.
금액	checkout.order.total_money.amount	integer	금액입니다.
통화	checkout.order.total_money.currency	string	통화입니다.
금액	checkout.order.total_tax_money.amount	integer	금액입니다.
통화	checkout.order.total_tax_money.currency	string	통화입니다.
금액	checkout.order.total_discount_money.amount	integer	금액입니다.
통화	checkout.order.total_discount_money.currency	string	통화입니다.
만든 위치에서	checkout.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
버전	checkout.version	integer	이 개체의 현재 버전입니다.
추가 받는 사람	checkout.additional_recipients	array of object
위치 ID	checkout.additional_recipients.location_id	string	이 입찰의 일부를 받는 받는 사람(가맹점 이외의)의 위치 ID입니다.
Description	checkout.additional_recipients.title	string	항목의 설명입니다. 이 특성은 해당 쿼리 필터에서 사용할 수 있는 검색 가능한 특성이며 값 길이는 유니코드 코드 포인트입니다.
금액	checkout.additional_recipients.amount_money.amount	integer	금액입니다.
통화	checkout.additional_recipients.amount_money.currency	string	통화입니다.

충성도 포인트 계산

작업 ID:

LoyaltyCalculatePoints

구매에서 획득한 포인트를 계산합니다. 애플리케이션은 이 엔드포인트를 호출하여 구매자가 특정 구매로 얻을 수 있는 포인트를 표시할 수 있습니다.

매개 변수

Name	키	필수	형식	Description
프로그램 ID	program_id	True	string	프로그램의 식별자입니다.
주문 ID	order_id		string	주문 식별자입니다.

반환

Name	경로	형식	Description
포인트	points	integer	구매자가 지정된 구매로 얻을 수 있는 포인트입니다.

코드 조각 검색

작업 ID:

SnippetRetrieve

Square Online 사이트에서 코드 조각을 검색합니다. 사이트에는 여러 코드 조각 애플리케이션의 코드 조각이 포함될 수 있지만 애플리케이션에서 추가한 코드 조각만 검색할 수 있습니다.

매개 변수

Name	키	필수	형식	Description
사이트 아이디	site_id	True	string	사이트의 식별자입니다.

반환

Name	경로	형식	Description
아이디	snippet.id	string	Square에서 발급한 고유한 식별자입니다.
사이트 아이디	snippet.site_id	string	코드 조각이 포함된 사이트의 ID입니다.
Content	snippet.content	string	유효한 HTML, JavaScript 또는 둘 다를 포함할 수 있는 코드 조각 코드입니다.
만든 위치에서	snippet.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	snippet.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.

코드 조각 삭제

작업 ID:

SnippetDelete

Square Online 사이트에서 코드 조각을 제거합니다.

매개 변수

Name	키	필수	형식	Description
사이트 아이디	site_id	True	string	사이트의 식별자입니다.

반환

response

object

팀 구성원 검색

작업 ID:

TeamRetrieveMember

지정된 TeamMember ID에 대한 TeamMember 개체를 검색합니다.

매개 변수

Name	키	필수	형식	Description
팀 구성원 ID	team_member_id	True	string	팀 구성원의 식별자입니다.

반환

Name	경로	형식	Description
아이디	team_member.id	string	Square에서 발급한 고유한 식별자입니다.
참조 ID	team_member.reference_id	string	선택적 사용자 정의 참조 ID입니다.
소유자인 경우	team_member.is_owner	boolean	팀 구성원이 Square 계정의 소유자인지 여부입니다.
상태	team_member.status	string	이 개체의 현재 확인 상태입니다.
이름 (주어진 이름)	team_member.given_name	string	고객 프로필과 연결된 지정된 이름(즉, 첫 번째)입니다.
성	team_member.family_name	string	고객 프로필과 연결된 가족(즉, 마지막) 이름입니다.
이메일 주소	team_member.email_address	string	고객 프로필과 연결된 이메일 주소입니다.
전화 번호	team_member.phone_number	string	고객 프로필과 연결된 11자리 전화 번호입니다.
만든 위치에서	team_member.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
업데이트 날짜	team_member.updated_at	string	이 개체의 가장 최근 업데이트 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
배정 유형	team_member.assigned_locations.assignment_type	string	팀 구성원의 현재 할당 유형입니다.
위치 ID	team_member.assigned_locations.location_ids	array of string

팀 구성원 검색

작업 ID:

TeamSearch

비즈니스에 대한 TeamMember 개체의 페이지를 매긴 목록을 반환합니다.

매개 변수

Name	키	필수	형식	Description
위치 ID	location_ids		array of string
상태	status		string	현재 상태입니다.
한계	limit		integer	단일 페이지에서 반환할 결과 수에 대한 제한입니다. 제한은 권고입니다. 구현은 더 많거나 적은 결과를 반환할 수 있습니다. 제공된 제한이 음수, 0 또는 최대 제한인 1,000보다 높은 경우 무시됩니다.

반환

Name	경로	형식	Description
팀 구성원	team_members	array of object
아이디	team_members.id	string	Square에서 발급한 고유한 식별자입니다.
참조 ID	team_members.reference_id	string	고객 프로필을 다른 시스템의 엔터티와 연결하는 데 사용되는 선택적 두 번째 ID입니다.
소유자인 경우	team_members.is_owner	boolean	팀 구성원이 Square 계정의 소유자인지 여부입니다.
상태	team_members.status	string	이 개체의 현재 확인 상태입니다.
이름 (주어진 이름)	team_members.given_name	string	고객 프로필과 연결된 지정된 이름(즉, 첫 번째)입니다.
성	team_members.family_name	string	고객 프로필과 연결된 가족(즉, 마지막) 이름입니다.
이메일 주소	team_members.email_address	string	고객 프로필과 연결된 이메일 주소입니다.
만든 위치에서	team_members.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
업데이트 날짜	team_members.updated_at	string	RFC 3339 형식의 마지막 수정 타임스탬프
배정 유형	team_members.assigned_locations.assignment_type	string	팀 구성원의 현재 할당 유형입니다.
전화 번호	team_members.phone_number	string	고객 프로필과 연결된 11자리 전화 번호입니다.
Cursor	cursor	string	원래 쿼리와 연결된 다음 결과 집합을 검색하기 위해 이 엔드포인트에 대한 후속 호출에 페이지 매김 커서를 포함합니다.

팀 구성원 대량 만들기

작업 ID:

TeamCreateBulkMembers

여러 TeamMember 개체를 만듭니다.

매개 변수

Name	키	필수	형식	Description
이름 (주어진 이름)	given_name		string	팀 구성원과 연결된 지정된 이름(즉, 이름)입니다.
성	family_name		string	팀 구성원과 연결된 가족 이름(즉, 성)입니다.
이메일 주소	email_address		string	팀 구성원과 연결된 전자 메일 주소입니다.
참조 ID	reference_id		string	팀 구성원을 다른 시스템의 엔터티와 연결하는 데 사용되는 두 번째 ID입니다.
전화 번호	phone_number		string	팀 구성원의 전화 번호(E.164 형식)입니다.
위치 ID	location_ids		array of string
배정 유형	assignment_type		string	팀 구성원의 현재 할당 유형입니다.
이름 (주어진 이름)	given_name		string	팀 구성원과 연결된 지정된 이름(즉, 이름)입니다.
성	family_name		string	팀 구성원과 연결된 가족 이름(즉, 성)입니다.
이메일 주소	email_address		string	팀 구성원과 연결된 전자 메일 주소입니다.
참조 ID	reference_id		string	팀 구성원을 다른 시스템의 엔터티와 연결하는 데 사용되는 두 번째 ID입니다.
전화 번호	phone_number		string	팀 구성원의 전화 번호(E.164 형식)입니다.
배정 유형	assignment_type		string	팀 구성원의 현재 할당 유형입니다.

반환

Name	경로	형식	Description
아이디	team_members.idempotency-key-1.team_member.id	string	이 개체를 참조할 식별자입니다.
참조 ID	team_members.idempotency-key-1.team_member.reference_id	string	팀 구성원을 다른 시스템의 엔터티와 연결하는 데 사용되는 두 번째 ID입니다.
소유자인 경우	team_members.idempotency-key-1.team_member.is_owner	boolean	팀 구성원이 Square 계정의 소유자인지 여부입니다.
상태	team_members.idempotency-key-1.team_member.status	string	팀 구성원의 상태를 설명합니다.
이름 (주어진 이름)	team_members.idempotency-key-1.team_member.given_name	string	팀 구성원과 연결된 지정된 이름(즉, 이름)입니다.
성	team_members.idempotency-key-1.team_member.family_name	string	팀 구성원과 연결된 가족 이름(즉, 성)입니다.
이메일 주소	team_members.idempotency-key-1.team_member.email_address	string	팀 구성원과 연결된 전자 메일 주소입니다.
전화 번호	team_members.idempotency-key-1.team_member.phone_number	string	팀 구성원의 전화 번호(E.164 형식)입니다.
배정 유형	team_members.idempotency-key-1.team_member.assigned_locations.assignment_type	string	팀 구성원의 현재 할당 유형입니다.
위치 ID	team_members.idempotency-key-1.team_member.assigned_locations.location_ids	array of string
아이디	team_members.idempotency-key-2.team_member.id	string	이 개체를 참조할 식별자입니다.
참조 ID	team_members.idempotency-key-2.team_member.reference_id	string	팀 구성원을 다른 시스템의 엔터티와 연결하는 데 사용되는 두 번째 ID입니다.
소유자인 경우	team_members.idempotency-key-2.team_member.is_owner	boolean	팀 구성원이 Square 계정의 소유자인지 여부입니다.
상태	team_members.idempotency-key-2.team_member.status	string	팀 구성원의 상태를 설명합니다.
이름 (주어진 이름)	team_members.idempotency-key-2.team_member.given_name	string	팀 구성원과 연결된 지정된 이름(즉, 이름)입니다.
성	team_members.idempotency-key-2.team_member.family_name	string	팀 구성원과 연결된 가족 이름(즉, 성)입니다.
이메일 주소	team_members.idempotency-key-2.team_member.email_address	string	팀 구성원과 연결된 전자 메일 주소입니다.
전화 번호	team_members.idempotency-key-2.team_member.phone_number	string	팀 구성원의 전화 번호(E.164 형식)입니다.
배정 유형	team_members.idempotency-key-2.team_member.assigned_locations.assignment_type	string	팀 구성원의 현재 할당 유형입니다.

팀 구성원 대량 업데이트

작업 ID:

TeamUpdateBulkMembers

여러 TeamMember 개체를 업데이트합니다.

매개 변수

Name	키	필수	형식	Description
참조 ID	reference_id		string	팀 구성원을 다른 시스템의 엔터티와 연결하는 데 사용되는 두 번째 ID입니다.
소유자인 경우	is_owner		boolean	팀 구성원이 Square 계정의 소유자인지 여부입니다.
상태	status		string	팀 구성원의 상태를 설명합니다.
이름 (주어진 이름)	given_name		string	팀 구성원과 연결된 지정된 이름(즉, 이름)입니다.
성	family_name		string	팀 구성원과 연결된 가족 이름(즉, 성)입니다.
이메일 주소	email_address		string	팀 구성원과 연결된 전자 메일 주소입니다.
전화 번호	phone_number		string	팀 구성원의 전화 번호(E.164 형식)입니다.
위치 ID	location_ids		array of string
배정 유형	assignment_type		string	팀 구성원의 현재 할당 유형입니다.
참조 ID	reference_id		string	팀 구성원을 다른 시스템의 엔터티와 연결하는 데 사용되는 두 번째 ID입니다.
소유자인 경우	is_owner		boolean	팀 구성원이 Square 계정의 소유자인지 여부입니다.
상태	status		string	팀 구성원의 상태를 설명합니다.
이름 (주어진 이름)	given_name		string	팀 구성원과 연결된 지정된 이름(즉, 이름)입니다.
성	family_name		string	팀 구성원과 연결된 가족 이름(즉, 성)입니다.
이메일 주소	email_address		string	팀 구성원과 연결된 전자 메일 주소입니다.
전화 번호	phone_number		string	팀 구성원의 전화 번호(E.164 형식)입니다.
배정 유형	assignment_type		string	팀 구성원의 현재 할당 유형입니다.

반환

Name	경로	형식	Description
아이디	team_members.team_member_id.team_member.id	string	이 개체를 참조할 식별자입니다.
참조 ID	team_members.team_member_id.team_member.reference_id	string	팀 구성원을 다른 시스템의 엔터티와 연결하는 데 사용되는 두 번째 ID입니다.
소유자인 경우	team_members.team_member_id.team_member.is_owner	boolean	팀 구성원이 Square 계정의 소유자인지 여부입니다.
상태	team_members.team_member_id.team_member.status	string	팀 구성원의 상태를 설명합니다.
이름 (주어진 이름)	team_members.team_member_id.team_member.given_name	string	팀 구성원과 연결된 지정된 이름(즉, 이름)입니다.
성	team_members.team_member_id.team_member.family_name	string	팀 구성원과 연결된 가족 이름(즉, 성)입니다.
이메일 주소	team_members.team_member_id.team_member.email_address	string	팀 구성원과 연결된 전자 메일 주소입니다.
전화 번호	team_members.team_member_id.team_member.phone_number	string	팀 구성원의 전화 번호(E.164 형식)입니다.
만든 위치에서	team_members.team_member_id.team_member.created_at	string	팀 구성원이 만들어진 시기를 설명하는 RFC 3339 형식의 타임스탬프
배정 유형	team_members.team_member_id.team_member.assigned_locations.assignment_type	string	팀 구성원의 현재 할당 유형입니다.
위치 ID	team_members.team_member_id.team_member.assigned_locations.location_ids	array of string

팀 구성원 만들기

작업 ID:

TeamCreateMember

단일 TeamMember 개체를 만듭니다.

매개 변수

Name	키	필수	형식	Description
Idempotency 키	idempotency_key		string	모든 요청 중에서 이 요청을 고유하게 식별하는 값을 지정합니다. 유효한 idempotency 키를 만드는 일반적인 방법은 UUID(유니버설 고유 식별자)를 사용하는 것입니다.
참조 ID	reference_id		string	선택적 사용자 정의 참조 ID입니다.
상태	status		string	이 개체의 현재 확인 상태입니다.
이름 (주어진 이름)	given_name		string	고객 프로필과 연결된 지정된 이름(즉, 첫 번째)입니다.
성	family_name		string	고객 프로필과 연결된 가족(즉, 마지막) 이름입니다.
이메일 주소	email_address		string	고객 프로필과 연결된 이메일 주소입니다.
전화 번호	phone_number		string	고객 프로필과 연결된 11자리 전화 번호입니다.
위치 ID	location_ids		array of string
배정 유형	assignment_type		string	팀 구성원의 현재 할당 유형입니다.

반환

Name	경로	형식	Description
아이디	team_member.id	string	Square에서 발급한 고유한 식별자입니다.
참조 ID	team_member.reference_id	string	선택적 사용자 정의 참조 ID입니다.
소유자인 경우	team_member.is_owner	boolean	팀 구성원이 Square 계정의 소유자인지 여부입니다.
상태	team_member.status	string	이 개체의 현재 확인 상태입니다.
이름 (주어진 이름)	team_member.given_name	string	고객 프로필과 연결된 지정된 이름(즉, 첫 번째)입니다.
성	team_member.family_name	string	고객 프로필과 연결된 가족(즉, 마지막) 이름입니다.
이메일 주소	team_member.email_address	string	고객 프로필과 연결된 이메일 주소입니다.
전화 번호	team_member.phone_number	string	고객 프로필과 연결된 11자리 전화 번호입니다.
배정 유형	team_member.assigned_locations.assignment_type	string	팀 구성원의 현재 할당 유형입니다.
위치 ID	team_member.assigned_locations.location_ids	array of string

팀 구성원 업데이트

작업 ID:

TeamUpdate

단일 TeamMember 개체를 업데이트합니다.

매개 변수

Name	키	필수	형식	Description
팀 구성원 ID	team_member_id	True	string	팀 구성원의 식별자입니다.
참조 ID	reference_id		string	선택적 사용자 정의 참조 ID입니다.
상태	status		string	이 개체의 현재 확인 상태입니다.
이름 (주어진 이름)	given_name		string	고객 프로필과 연결된 지정된 이름(즉, 첫 번째)입니다.
성	family_name		string	고객 프로필과 연결된 가족(즉, 마지막) 이름입니다.
이메일 주소	email_address		string	고객 프로필과 연결된 이메일 주소입니다.
전화 번호	phone_number		string	고객 프로필과 연결된 11자리 전화 번호입니다.
위치 ID	location_ids		array of string
배정 유형	assignment_type		string	팀 구성원의 현재 할당 유형입니다.

반환

Name	경로	형식	Description
아이디	team_member.id	string	Square에서 발급한 고유한 식별자입니다.
참조 ID	team_member.reference_id	string	선택적 사용자 정의 참조 ID입니다.
소유자인 경우	team_member.is_owner	boolean	팀 구성원이 Square 계정의 소유자인지 여부입니다.
상태	team_member.status	string	이 개체의 현재 확인 상태입니다.
이름 (주어진 이름)	team_member.given_name	string	고객 프로필과 연결된 지정된 이름(즉, 첫 번째)입니다.
성	team_member.family_name	string	고객 프로필과 연결된 가족(즉, 마지막) 이름입니다.
이메일 주소	team_member.email_address	string	고객 프로필과 연결된 이메일 주소입니다.
전화 번호	team_member.phone_number	string	고객 프로필과 연결된 11자리 전화 번호입니다.
만든 위치에서	team_member.created_at	string	이 개체의 생성 시간을 RFC 3339 형식으로 지정하는 타임스탬프입니다.
배정 유형	team_member.assigned_locations.assignment_type	string	팀 구성원의 현재 할당 유형입니다.
위치 ID	team_member.assigned_locations.location_ids	array of string

팀 구성원 예약 프로필 나열(베타)

작업 ID:

BookingListTeamProfiles

팀 구성원의 예약 프로필을 나열합니다.

매개 변수

Name	키	필수	형식	Description
예약 가능만	bookable_only		boolean	반환된 결과(true)에 예약 가능한 팀 구성원만 포함할지 여부(false)를 나타냅니다.
한계	limit		integer	응답에서 반환할 수의 상한입니다.
Cursor	cursor		string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.
위치 ID	location_id		string	이 선택적 필터를 지정하여 특정 위치에 속하는 레코드만 검색할 수 있습니다.

반환

Name	경로	형식	Description
팀 구성원 예약 프로필	team_member_booking_profiles	array of object
팀 구성원 ID	team_member_booking_profiles.team_member_id	string	개체와 연결된 팀 구성원에 대한 TeamMember 개체의 ID입니다.
표시 이름	team_member_booking_profiles.display_name	string	팀 구성원의 표시 이름입니다.
예약 가능	team_member_booking_profiles.is_bookable	boolean	Bookings API 또는 판매자의 온라인 예약 채널 또는 사이트(true)를 통해 팀 구성원을 예약할 수 있는지 여부(false')를 나타냅니다.
Errors	errors	array of

팀 구성원 임금 나열

작업 ID:

LaborListWages

비즈니스에 대한 TeamMemberWage 인스턴스의 페이지를 매긴 목록을 반환합니다.

매개 변수

Name	키	필수	형식	Description
팀 구성원 ID	team_member_id		string	반환된 임금을 지정된 팀 구성원과 연결된 임금으로만 필터링합니다.
한계	limit		integer	응답에서 반환할 수의 상한입니다.
Cursor	cursor		string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.

반환

Name	경로	형식	Description
팀 구성원 임금	team_member_wages	array of object
아이디	team_member_wages.id	string	Square에서 발급한 고유한 식별자입니다.
팀 구성원 ID	team_member_wages.team_member_id	string	개체와 연결된 팀 구성원에 대한 TeamMember 개체의 ID입니다.
제목	team_member_wages.title	string	청구서의 제목입니다.
금액	team_member_wages.hourly_rate.amount	integer	금액입니다.
통화	team_member_wages.hourly_rate.currency	string	통화입니다.
Cursor	cursor	string	원래 쿼리와 연결된 다음 결과 집합을 검색하기 위해 이 엔드포인트에 대한 후속 호출에 페이지 매김 커서를 포함합니다.

팀 구성원 임금 받기

작업 ID:

LaborGetWage

ID로 지정된 단일 TeamMemberWage를 반환합니다.

매개 변수

Name	키	필수	형식	Description
아이디	id	True	string	식별자입니다.

반환

Name	경로	형식	Description
아이디	team_member_wage.id	string	Square에서 발급한 고유한 식별자입니다.
팀 구성원 ID	team_member_wage.team_member_id	string	팀 구성원의 ID입니다.
제목	team_member_wage.title	string	제목입니다.
금액	team_member_wage.hourly_rate.amount	integer	금액입니다.
통화	team_member_wage.hourly_rate.currency	string	통화입니다.

현금 서랍 교대 이벤트 나열

작업 ID:

CashDrawerListEvents

단일 현금 서랍 교대 근무에 대해 페이지를 매긴 이벤트 목록을 제공합니다.

매개 변수

Name	키	필수	형식	Description
Shift ID	shift_id	True	string	시프트의 식별자입니다.
위치 ID	location_id	True	string	이 선택적 필터를 지정하여 특정 위치에 속하는 레코드만 검색할 수 있습니다.
한계	limit		integer	응답에서 반환할 수의 상한입니다.
Cursor	cursor		string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.

반환

Name	경로	형식	Description
Events	events	array of object
아이디	events.id	string	Square에서 발급한 고유한 식별자입니다.
이벤트 유형	events.event_type	string	현금 서랍 시프트 이벤트의 유형입니다.
금액	events.event_money.amount	integer	금액입니다.
통화	events.event_money.currency	string	통화입니다.
만든 위치에서	events.created_at	string	ISO 8601 형식의 이벤트 시간입니다.
Description	events.title	string	설명입니다.

현금 서랍 교대조 검색

작업 ID:

CashDrawerRetrieveShift

단일 현금 서랍 교대 근무에 대한 요약 세부 정보를 제공합니다.

매개 변수

Name	키	필수	형식	Description
Shift ID	shift_id	True	string	시프트의 식별자입니다.
위치 ID	location_id	True	string	이 선택적 필터를 지정하여 특정 위치에 속하는 레코드만 검색할 수 있습니다.

반환

Name	경로	형식	Description
아이디	cash_drawer_shift.id	string	Square에서 발급한 고유한 식별자입니다.
주	cash_drawer_shift.state	string	현재 상태입니다.
Opened At	cash_drawer_shift.opened_at	string	ISO 8601 형식으로 교대 근무가 시작된 시간입니다.
종료됨	cash_drawer_shift.ended_at	string	교대 근무가 종료된 시간(ISO 8601 형식)입니다.
닫힘	cash_drawer_shift.closed_at	string	ISO 8601 형식으로 닫힌 시간입니다.
직원 ID 열기	cash_drawer_shift.opening_employee_id	string	현금 서랍 교대 근무를 시작한 직원의 ID입니다.
직원 ID 종료	cash_drawer_shift.ending_employee_id	string	현금 서랍 교대 근무를 종료한 직원의 ID입니다.
직원 ID 닫기	cash_drawer_shift.closing_employee_id	string	현금 서랍 내용을 감사하여 현금 서랍 교대 근무를 마감한 직원의 ID입니다.
Description	cash_drawer_shift.description	string	설명입니다.
금액	cash_drawer_shift.opened_cash_money.amount	integer	금액입니다.
통화	cash_drawer_shift.opened_cash_money.currency	string	통화입니다.
금액	cash_drawer_shift.cash_payment_money.amount	integer	금액입니다.
통화	cash_drawer_shift.cash_payment_money.currency	string	통화입니다.
금액	cash_drawer_shift.cash_refunds_money.amount	integer	금액입니다.
통화	cash_drawer_shift.cash_refunds_money.currency	string	통화입니다.
금액	cash_drawer_shift.cash_paid_in_money.amount	integer	금액입니다.
통화	cash_drawer_shift.cash_paid_in_money.currency	string	통화입니다.
금액	cash_drawer_shift.cash_paid_out_money.amount	integer	금액입니다.
통화	cash_drawer_shift.cash_paid_out_money.currency	string	통화입니다.
금액	cash_drawer_shift.expected_cash_money.amount	integer	금액입니다.
통화	cash_drawer_shift.expected_cash_money.currency	string	통화입니다.
금액	cash_drawer_shift.closed_cash_money.amount	integer	금액입니다.
통화	cash_drawer_shift.closed_cash_money.currency	string	통화입니다.
이름	cash_drawer_shift.device.name	string	이름입니다.

현금 서랍 교대조 나열

작업 ID:

CashDrawerListShifts

날짜 범위의 위치에 대한 모든 현금 서랍 교대조에 대한 세부 정보를 제공합니다.

매개 변수

Name	키	필수	형식	Description
위치 ID	location_id		string	이 선택적 필터를 지정하여 특정 위치에 속하는 레코드만 검색할 수 있습니다.
정렬 순서	sort_order		string	지정된 순서로 카드를 만든 시점을 기준으로 반환된 목록을 정렬합니다.
시작 시간	begin_time		string	opened_at 쿼리의 포괄 시작 시간(ISO 8601 형식)입니다.
종료 시간	end_time		string	opened_at 쿼리의 전용 종료 날짜(ISO 8601 형식)입니다.
한계	limit		integer	응답에서 반환할 수의 상한입니다.
Cursor	cursor		string	이 엔드포인트에 대한 이전 호출에서 반환된 페이지 매김 커서입니다.

반환

Name	경로	형식	Description
아이템	items	array of object
아이디	items.id	string	Square에서 발급한 고유한 식별자입니다.
주	items.state	string	현재 상태입니다.
Opened At	items.opened_at	string	ISO 8601 형식의 교대 근무 시작 시간입니다.
종료됨	items.ended_at	string	ISO 8601 형식의 시프트 종료 시간입니다.
닫힘	items.closed_at	string	ISO 8601 형식의 시프트 닫기 시간입니다.
Description	items.title	string	설명입니다.
금액	items.opened_cash_money.amount	integer	금액입니다.
통화	items.opened_cash_money.currency	string	통화입니다.
금액	items.expected_cash_money.amount	integer	금액입니다.
통화	items.expected_cash_money.currency	string	통화입니다.
금액	items.closed_cash_money.amount	integer	금액입니다.
통화	items.closed_cash_money.currency	string	통화입니다.

정의

객체

'object' 형식입니다.