docs.jsonld
type: ApiDocumentation
title: TrackMage API
description: TrackMage API
entrypoint: /
supported class: User
supported class: Team
supported class: TeamMember
supported class: WorkspaceMember
supported class: UserSignupRequest
supported class: UserVerifyEmailRequest
supported class: UserResendEmailRequest
supported class: ForgotPasswordSendEmailRequest
supported class: ApplyWorkspacePermissionsBatchRequest
supported class: GenerateTrackingPageLinkRequest
supported class: GenerateTrackingPageLinksRequest
supported class: GenerateThemeRequest
supported class: CheckTrackingStatusesRequest
supported class: CheckTrackingStatusesAsyncRequest
supported class: PostReviewRequest
supported class: HandleChargebeeWebhookRequest
supported class: CreateChargebeeSessionRequest
supported class: CreateChargebeeHostedPageCheckoutRequest
supported class: GetChargebeeSubscriptionEstimateRequest
supported class: DowngradeChargebeeSubscriptionRequest
supported class: CheckoutShopifySubscriptionRequest
supported class: VerifyDomainRequest
supported class: VerifyProductsFeedRequest
supported class: ImportProductsFeedRequest
supported class: LoadDatabaseFixturesRequest
supported class: SubdomainCheckRequest
supported class: ShopifyRegisterRequest
supported class: ShopifyWorkspaceRequest
supported class: KlaviyoWorkspaceRequest
supported class: Review
supported class: Workspace
supported class: Credentials
supported class: Workflow
supported class: WorkflowRun
supported class: Address
supported class: Shipment
supported class: TrackingCheckpoint
supported class: OauthClient
supported class: Media
supported class: Import
supported class: TrackingPage
supported class: Field
supported class: EmailNotification
supported class: FieldsLayout
supported class: Carrier
supported class: TrackingStatus
supported class: Timezone
supported class: Country
supported class: State
supported class: EntityType
supported class: ChangeStatusBatchAsyncRequest
supported class: Notification
supported class: Order
supported class: OrderItem
supported class: ShipmentItem
supported class: Status
supported class: Note
supported class: NoteReminder
supported class: Product
supported class: ProductVariant
supported class: LookupInvitationTeamNameRequest
supported class: Widget
supported class: WidgetLog
supported class: ExportEntityRequest
supported class: MarkNotificationsAsReadRequest
supported class: SubscribeTeamOnTrialRequest
supported class: Entrypoint
supported class: ConstraintViolation
supported class: ConstraintViolationList

User
type: Class
title: User
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailVerified
  title: emailVerified
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: passwordSet
  title: passwordSet
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: trialRedeemed
  title: trialRedeemed
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: plainPassword
  title: plainPassword
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: timezone
  title: timezone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: refTrackingId
  title: refTrackingId
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: photo
  title: photo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipmentsVolume
  title: shipmentsVolume
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: needsHelpWith
  title: needsHelpWith
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: nextOnboardingStep
  title: nextOnboardingStep
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: teams
  title: teams
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: matomoId
  title: matomoId
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: matomoReferrer
  title: matomoReferrer
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: passedBusinessType
  title: passedBusinessType
  required: false
  readable: true
  writeable: false
supported operation: Retrieves User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves User resource.
  returns: User
supported operation: Replaces the User resource.
  type: Operation
  type: ReplaceAction
  expects: User
  method: PUT
  title: Replaces the User resource.
  returns: User
supported operation: Retrieves the collection of TeamMember resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TeamMember resources.
  returns: TeamMember
supported operation: Retrieves the collection of Notification resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Notification resources.
  returns: Notification

email
type: Property
domain: User
range: string
domain: UserSignupRequest
domain: UserResendEmailRequest
domain: ForgotPasswordSendEmailRequest
domain: GenerateThemeRequest
domain: ShopifyRegisterRequest
domain: Shipment
domain: Order
domain: LookupInvitationTeamNameRequest

firstName
type: Property
domain: User
range: string

lastName
type: Property
domain: User
range: string

emailVerified
type: Property
domain: User
range: boolean

passwordSet
type: Property
domain: User
range: boolean

trialRedeemed
type: Property
domain: User
range: boolean

plainPassword
type: Property
domain: User
range: string

timezone
type: Property
domain: User
range: string

refTrackingId
type: Property
domain: User
range: string

photo
type: Property
domain: User
max cardinality: 1
range: Media

shipmentsVolume
type: Property
domain: User
range: integer

needsHelpWith
type: Property
domain: User
range: string

nextOnboardingStep
type: Property
domain: User
range: string

teams
type: Link
domain: User
range: Team

matomoId
type: Property
domain: User
range: string

matomoReferrer
type: Property
domain: User
range: string

passedBusinessType
type: Property
domain: User
range: boolean

Team
type: Class
title: Team
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspaces
  title: workspaces
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: workspacesCount
  title: workspacesCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: usersCount
  title: usersCount
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entitlements
  title: entitlements
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: subscription
  title: subscription
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: billingProvider
  title: billingProvider
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: shopifyBillingWorkflowId
  title: shopifyBillingWorkflowId
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Team resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Team resource.
  returns: Team
supported operation: Replaces the Team resource.
  type: Operation
  type: ReplaceAction
  expects: Team
  method: PUT
  title: Replaces the Team resource.
  returns: Team
supported operation: Deletes the Team resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Team resource.
  returns: Nothing
supported operation: Retrieves the collection of Workspace resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Workspace resources.
  returns: Workspace
supported operation: Retrieves the collection of Shipment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Shipment resources.
  returns: Shipment
supported operation: Retrieves the collection of TrackingCheckpoint resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TrackingCheckpoint resources.
  returns: TrackingCheckpoint
supported operation: Retrieves the collection of ShipmentItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShipmentItem resources.
  returns: ShipmentItem
supported operation: Retrieves the collection of Order resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Order resources.
  returns: Order
supported operation: Retrieves the collection of OrderItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrderItem resources.
  returns: OrderItem
supported operation: Retrieves the collection of ShipmentItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShipmentItem resources.
  returns: ShipmentItem
supported operation: Retrieves the collection of Status resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Status resources.
  returns: Status
supported operation: Retrieves the collection of TrackingPage resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TrackingPage resources.
  returns: TrackingPage
supported operation: Retrieves the collection of EmailNotification resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EmailNotification resources.
  returns: EmailNotification
supported operation: Retrieves the collection of Note resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Note resources.
  returns: Note
supported operation: Retrieves the collection of Media resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Media resources.
  returns: Media
supported operation: Retrieves the collection of NoteReminder resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of NoteReminder resources.
  returns: NoteReminder
supported operation: Retrieves the collection of Workflow resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Workflow resources.
  returns: Workflow
supported operation: Retrieves the collection of WorkflowRun resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WorkflowRun resources.
  returns: WorkflowRun
supported operation: Retrieves the collection of Widget resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Widget resources.
  returns: Widget
supported operation: Retrieves the collection of WidgetLog resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WidgetLog resources.
  returns: WidgetLog
supported operation: Retrieves the collection of TeamMember resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TeamMember resources.
  returns: TeamMember
supported operation: Retrieves the collection of Credentials resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Credentials resources.
  returns: Credentials

name
type: Property
domain: Team
range: string

workspaces
type: Link
domain: Team
range: Workspace

workspacesCount
type: Property
domain: Team
range: integer

usersCount
type: Property
domain: Team
range: integer

entitlements
type: Property
domain: Team

subscription
type: Property
domain: Team

billingProvider
type: Property
domain: Team
range: string

shopifyBillingWorkflowId
type: Property
domain: Team
range: string

TeamMember
type: Class
title: TeamMember
supported property: SupportedProperty
  property: team
  title: team
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: invitedEmail
  title: invitedEmail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: member
  title: member
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: teamAdmin
  title: teamAdmin
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: teamOwner
  title: teamOwner
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: memberName
  title: memberName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: memberPhoto
  title: memberPhoto
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: memberEmail
  title: memberEmail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: memberLastLoggedIn
  title: memberLastLoggedIn
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: teamName
  title: teamName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: teamId
  title: teamId
  required: false
  readable: true
  writeable: false
supported operation: Retrieves TeamMember resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves TeamMember resource.
  returns: TeamMember
supported operation: Replaces the TeamMember resource.
  type: Operation
  type: ReplaceAction
  expects: TeamMember
  method: PUT
  title: Replaces the TeamMember resource.
  returns: TeamMember
supported operation: Deletes the TeamMember resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the TeamMember resource.
  returns: Nothing
supported operation: Creates a TeamMember resource.
  type: Operation
  type: CreateAction
  expects: TeamMember
  method: POST
  title: Creates a TeamMember resource.
  returns: TeamMember

team
type: Property
domain: TeamMember
max cardinality: 1
range: Team

invitedEmail
type: Property
domain: TeamMember
range: string

member
type: Link
domain: TeamMember
max cardinality: 1
range: User

teamAdmin
type: Property
domain: TeamMember
range: boolean

teamOwner
type: Property
domain: TeamMember
range: boolean

memberName
type: Property
domain: TeamMember
range: string

memberPhoto
type: Property
domain: TeamMember
range: string

memberEmail
type: Property
domain: TeamMember
range: string

memberLastLoggedIn
type: Property
domain: TeamMember
range: dateTime

teamName
type: Property
domain: TeamMember
range: string

teamId
type: Property
domain: TeamMember
range: string

WorkspaceMember
type: Class
title: WorkspaceMember
supported property: SupportedProperty
  property: workspace
  title: workspace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: member
  title: member
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accessLevel
  title: accessLevel
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspaceId
  title: workspaceId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: teamAdmin
  title: teamAdmin
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: memberName
  title: memberName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: memberPhoto
  title: memberPhoto
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: memberEmail
  title: memberEmail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: memberLastLoggedIn
  title: memberLastLoggedIn
  required: false
  readable: true
  writeable: false
supported operation: Retrieves WorkspaceMember resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves WorkspaceMember resource.
  returns: WorkspaceMember
supported operation: Replaces the WorkspaceMember resource.
  type: Operation
  type: ReplaceAction
  expects: WorkspaceMember
  method: PUT
  title: Replaces the WorkspaceMember resource.
  returns: WorkspaceMember
supported operation: Deletes the WorkspaceMember resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the WorkspaceMember resource.
  returns: Nothing

workspace
type: Property
domain: WorkspaceMember
max cardinality: 1
range: Workspace

member
type: Link
domain: WorkspaceMember
max cardinality: 1
range: User

accessLevel
type: Property
domain: WorkspaceMember
range: string

workspaceId
type: Property
domain: WorkspaceMember
range: string

teamAdmin
type: Property
domain: WorkspaceMember
range: boolean

memberName
type: Property
domain: WorkspaceMember
range: string

memberPhoto
type: Property
domain: WorkspaceMember
range: string

memberEmail
type: Property
domain: WorkspaceMember
range: string

memberLastLoggedIn
type: Property
domain: WorkspaceMember
range: dateTime

UserSignupRequest
type: Class
title: UserSignupRequest
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ip
  title: ip
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: beta
  title: beta
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: captcha
  title: captcha
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: refTrackingId
  title: refTrackingId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: invitationCode
  title: invitationCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: matomoId
  title: matomoId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: matomoReferrer
  title: matomoReferrer
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: password
  title: password
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailVerified
  title: emailVerified
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: onboardingStep
  title: onboardingStep
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: token
  title: token
  required: false
  readable: true
  writeable: true

ip
type: Property
domain: UserSignupRequest
range: string

beta
type: Property
domain: UserSignupRequest
range: boolean

captcha
type: Property
domain: UserSignupRequest
range: string

refTrackingId
type: Property
domain: UserSignupRequest
range: string

invitationCode
type: Property
domain: UserSignupRequest
range: string

matomoId
type: Property
domain: UserSignupRequest
range: string

matomoReferrer
type: Property
domain: UserSignupRequest
range: string

firstName
type: Property
domain: UserSignupRequest
range: string

lastName
type: Property
domain: UserSignupRequest
range: string

password
type: Property
domain: UserSignupRequest
range: string

emailVerified
type: Property
domain: UserSignupRequest
range: boolean

onboardingStep
type: Property
domain: UserSignupRequest
range: string

user
type: Property
domain: UserSignupRequest
max cardinality: 1
range: User

token
type: Property
domain: UserSignupRequest

UserVerifyEmailRequest
type: Class
title: UserVerifyEmailRequest
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true

code
type: Property
domain: UserVerifyEmailRequest
range: string

UserResendEmailRequest
type: Class
title: UserResendEmailRequest
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: captcha
  title: captcha
  required: false
  readable: true
  writeable: true

captcha
type: Property
domain: UserResendEmailRequest
range: string

ForgotPasswordSendEmailRequest
type: Class
title: ForgotPasswordSendEmailRequest
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: captcha
  title: captcha
  required: false
  readable: true
  writeable: true

captcha
type: Property
domain: ForgotPasswordSendEmailRequest
range: string

ApplyWorkspacePermissionsBatchRequest
type: Class
title: ApplyWorkspacePermissionsBatchRequest
supported property: SupportedProperty
  property: inviteMode
  title: inviteMode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: changes
  title: changes
  required: false
  readable: true
  writeable: true

inviteMode
type: Property
domain: ApplyWorkspacePermissionsBatchRequest
range: boolean

changes
type: Property
domain: ApplyWorkspacePermissionsBatchRequest

GenerateTrackingPageLinkRequest
type: Class
title: GenerateTrackingPageLinkRequest
supported property: SupportedProperty
  property: trackingPageId
  title: trackingPageId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: trackingNumber
  title: trackingNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: filter
  title: filter
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: preview
  title: preview
  required: false
  readable: true
  writeable: true

trackingPageId
type: Property
domain: GenerateTrackingPageLinkRequest
range: string

trackingNumber
type: Property
domain: GenerateTrackingPageLinkRequest
range: string

filter
type: Property
domain: GenerateTrackingPageLinkRequest

preview
type: Property
domain: GenerateTrackingPageLinkRequest
range: boolean

GenerateTrackingPageLinksRequest
type: Class
title: GenerateTrackingPageLinksRequest
supported property: SupportedProperty
  property: trackingPageId
  title: trackingPageId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: groupByField
  title: groupByField
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: filter
  title: filter
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true

trackingPageId
type: Property
domain: GenerateTrackingPageLinksRequest
range: string

groupByField
type: Property
domain: GenerateTrackingPageLinksRequest
range: string

filter
type: Property
domain: GenerateTrackingPageLinksRequest

userId
type: Property
domain: GenerateTrackingPageLinksRequest
range: string

GenerateThemeRequest
type: Class
title: GenerateThemeRequest
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: url
  title: url
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: agency
  title: agency
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: reuse
  title: reuse
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shorten
  title: shorten
  required: false
  readable: true
  writeable: true

userId
type: Property
domain: GenerateThemeRequest
range: string

url
type: Property
domain: GenerateThemeRequest
range: string
label: feedUrl
domain: VerifyProductsFeedRequest
label: imageUrl
domain: OrderItem
label: originUrl
domain: Product
domain: ProductVariant

firstName
type: Property
domain: GenerateThemeRequest
range: string

lastName
type: Property
domain: GenerateThemeRequest
range: string

agency
type: Property
domain: GenerateThemeRequest
range: boolean

reuse
type: Property
domain: GenerateThemeRequest
range: boolean

shorten
type: Property
domain: GenerateThemeRequest
range: boolean

CheckTrackingStatusesRequest
type: Class
title: CheckTrackingStatusesRequest
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspaceId
  title: workspaceId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: trackingNumbers
  title: trackingNumbers
  required: false
  readable: true
  writeable: true

userId
type: Property
domain: CheckTrackingStatusesRequest
range: string

workspaceId
type: Property
domain: CheckTrackingStatusesRequest
range: string

trackingNumbers
type: Property
domain: CheckTrackingStatusesRequest

CheckTrackingStatusesAsyncRequest
type: Class
title: CheckTrackingStatusesAsyncRequest
supported property: SupportedProperty
  property: workspaceId
  title: workspaceId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: trackingNumbers
  title: trackingNumbers
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true

workspaceId
type: Property
domain: CheckTrackingStatusesAsyncRequest
range: string

trackingNumbers
type: Property
domain: CheckTrackingStatusesAsyncRequest

userId
type: Property
domain: CheckTrackingStatusesAsyncRequest
range: string

PostReviewRequest
type: Class
title: PostReviewRequest
supported property: SupportedProperty
  property: hash
  title: hash
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: domain
  title: domain
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipmentId
  title: shipmentId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: carrierScore
  title: carrierScore
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: productScore
  title: productScore
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: packagingScore
  title: packagingScore
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: comment
  title: comment
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true

hash
type: Property
domain: PostReviewRequest
range: string

domain
type: Property
domain: PostReviewRequest
range: string

shipmentId
type: Property
domain: PostReviewRequest
range: string

carrierScore
type: Property
domain: PostReviewRequest
range: integer

productScore
type: Property
domain: PostReviewRequest
range: integer

packagingScore
type: Property
domain: PostReviewRequest
range: integer

comment
type: Property
domain: PostReviewRequest
range: string

id
type: Property
domain: PostReviewRequest
range: string

HandleChargebeeWebhookRequest
type: Class
title: HandleChargebeeWebhookRequest
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: occurred_at
  title: occurred_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: object
  title: object
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: api_version
  title: api_version
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: content
  title: content
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: event_type
  title: event_type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: webhook_status
  title: webhook_status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: webhooks
  title: webhooks
  required: false
  readable: true
  writeable: true

id
type: Property
domain: HandleChargebeeWebhookRequest
range: string

occurred_at
type: Property
domain: HandleChargebeeWebhookRequest
range: integer

source
type: Property
domain: HandleChargebeeWebhookRequest
range: string

user
type: Property
domain: HandleChargebeeWebhookRequest
range: string

object
type: Property
domain: HandleChargebeeWebhookRequest
range: string

api_version
type: Property
domain: HandleChargebeeWebhookRequest
range: string

content
type: Property
domain: HandleChargebeeWebhookRequest

event_type
type: Property
domain: HandleChargebeeWebhookRequest
range: string

webhook_status
type: Property
domain: HandleChargebeeWebhookRequest
range: string

webhooks
type: Property
domain: HandleChargebeeWebhookRequest

CreateChargebeeSessionRequest
type: Class
title: CreateChargebeeSessionRequest
supported property: SupportedProperty
  property: teamId
  title: teamId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: token
  title: token
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: access_url
  title: access_url
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created_at
  title: created_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: expires_at
  title: expires_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: object
  title: object
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customer_id
  title: customer_id
  required: false
  readable: true
  writeable: true

teamId
type: Property
domain: CreateChargebeeSessionRequest
range: string

userId
type: Property
domain: CreateChargebeeSessionRequest
range: string

id
type: Property
domain: CreateChargebeeSessionRequest
range: string

token
type: Property
domain: CreateChargebeeSessionRequest
range: string

access_url
type: Property
domain: CreateChargebeeSessionRequest
range: string

status
type: Property
domain: CreateChargebeeSessionRequest
range: string

created_at
type: Property
domain: CreateChargebeeSessionRequest
range: integer

expires_at
type: Property
domain: CreateChargebeeSessionRequest
range: integer

object
type: Property
domain: CreateChargebeeSessionRequest
range: string

customer_id
type: Property
domain: CreateChargebeeSessionRequest
range: string

CreateChargebeeHostedPageCheckoutRequest
type: Class
title: CreateChargebeeHostedPageCheckoutRequest
supported property: SupportedProperty
  property: intent
  title: intent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: teamId
  title: teamId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: planId
  title: planId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: addonsQtyByKey
  title: addonsQtyByKey
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: oneTimeAddonsQtyByKey
  title: oneTimeAddonsQtyByKey
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: redirectUrl
  title: redirectUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created_at
  title: created_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: embed
  title: embed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: expires_at
  title: expires_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: object
  title: object
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: resource_version
  title: resource_version
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updated_at
  title: updated_at
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: url
  title: url
  required: false
  readable: true
  writeable: true

intent
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest
range: string

teamId
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest
range: string

userId
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest
range: string

planId
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest
range: string

addonsQtyByKey
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest

oneTimeAddonsQtyByKey
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest

redirectUrl
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest
range: string

created_at
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest
range: integer

embed
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest
range: boolean

expires_at
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest
range: integer

id
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest
range: string

object
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest
range: string

resource_version
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest
range: integer

state
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest
range: string

type
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest
range: string

updated_at
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest
range: integer

url
type: Property
domain: CreateChargebeeHostedPageCheckoutRequest
range: string

GetChargebeeSubscriptionEstimateRequest
type: Class
title: GetChargebeeSubscriptionEstimateRequest
supported property: SupportedProperty
  property: teamId
  title: teamId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: planId
  title: planId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nextBillingAt
  title: nextBillingAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nextTotal
  title: nextTotal
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: currencyCode
  title: currencyCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: estimateItems
  title: estimateItems
  required: false
  readable: true
  writeable: true

teamId
type: Property
domain: GetChargebeeSubscriptionEstimateRequest
range: string

userId
type: Property
domain: GetChargebeeSubscriptionEstimateRequest
range: string

planId
type: Property
domain: GetChargebeeSubscriptionEstimateRequest
range: string

createdAt
type: Property
domain: GetChargebeeSubscriptionEstimateRequest
range: dateTime

nextBillingAt
type: Property
domain: GetChargebeeSubscriptionEstimateRequest
range: dateTime

nextTotal
type: Property
domain: GetChargebeeSubscriptionEstimateRequest
range: integer

currencyCode
type: Property
domain: GetChargebeeSubscriptionEstimateRequest
range: string

estimateItems
type: Property
domain: GetChargebeeSubscriptionEstimateRequest
range: string

DowngradeChargebeeSubscriptionRequest
type: Class
title: DowngradeChargebeeSubscriptionRequest
supported property: SupportedProperty
  property: teamId
  title: teamId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: planId
  title: planId
  required: false
  readable: true
  writeable: true

teamId
type: Property
domain: DowngradeChargebeeSubscriptionRequest
range: string

userId
type: Property
domain: DowngradeChargebeeSubscriptionRequest
range: string

planId
type: Property
domain: DowngradeChargebeeSubscriptionRequest
range: string

CheckoutShopifySubscriptionRequest
type: Class
title: CheckoutShopifySubscriptionRequest
supported property: SupportedProperty
  property: teamId
  title: teamId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: planId
  title: planId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: returnUrl
  title: returnUrl
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: confirmationUrl
  title: confirmationUrl
  required: false
  readable: true
  writeable: true

teamId
type: Property
domain: CheckoutShopifySubscriptionRequest
range: string

userId
type: Property
domain: CheckoutShopifySubscriptionRequest
range: string

planId
type: Property
domain: CheckoutShopifySubscriptionRequest
range: string

returnUrl
type: Property
domain: CheckoutShopifySubscriptionRequest
range: string

confirmationUrl
type: Property
domain: CheckoutShopifySubscriptionRequest
range: string

VerifyDomainRequest
type: Class
title: VerifyDomainRequest
supported property: SupportedProperty
  property: domain
  title: domain
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accessible
  title: accessible
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ssl
  title: ssl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: verified
  title: verified
  required: false
  readable: true
  writeable: true

domain
type: Property
domain: VerifyDomainRequest
range: string

accessible
type: Property
domain: VerifyDomainRequest
range: boolean

ssl
type: Property
domain: VerifyDomainRequest
range: boolean

verified
type: Property
domain: VerifyDomainRequest
range: boolean

VerifyProductsFeedRequest
type: Class
title: VerifyProductsFeedRequest
supported property: SupportedProperty
  property: url
  title: feedUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accessible
  title: accessible
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: verified
  title: verified
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: items
  title: items
  required: false
  readable: true
  writeable: true

accessible
type: Property
domain: VerifyProductsFeedRequest
range: boolean

verified
type: Property
domain: VerifyProductsFeedRequest
range: boolean

items
type: Property
domain: VerifyProductsFeedRequest

ImportProductsFeedRequest
type: Class
title: ImportProductsFeedRequest
supported property: SupportedProperty
  property: trackingPageId
  title: trackingPageId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: feedType
  title: feedType
  required: false
  readable: true
  writeable: true

trackingPageId
type: Property
domain: ImportProductsFeedRequest
range: string

feedType
type: Property
domain: ImportProductsFeedRequest
range: string

LoadDatabaseFixturesRequest
type: Class
title: LoadDatabaseFixturesRequest
supported property: SupportedProperty
  property: content
  title: content
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: skipped
  title: skipped
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: recreated
  title: recreated
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: processed
  title: processed
  required: false
  readable: true
  writeable: true

content
type: Property
domain: LoadDatabaseFixturesRequest
range: string

skipped
type: Property
domain: LoadDatabaseFixturesRequest
range: integer

recreated
type: Property
domain: LoadDatabaseFixturesRequest
range: integer

created
type: Property
domain: LoadDatabaseFixturesRequest
range: integer

processed
type: Property
domain: LoadDatabaseFixturesRequest
range: integer

SubdomainCheckRequest
type: Class
title: SubdomainCheckRequest
supported property: SupportedProperty
  property: subdomain
  title: subdomain
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: available
  title: available
  required: false
  readable: true
  writeable: true

subdomain
type: Property
domain: SubdomainCheckRequest
range: string

available
type: Property
domain: SubdomainCheckRequest
range: boolean

ShopifyRegisterRequest
type: Class
title: ShopifyRegisterRequest
supported property: SupportedProperty
  property: tokenId
  title: tokenId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailHash
  title: emailHash
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: plainPassword
  title: plainPassword
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: team
  title: team
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspace
  title: workspace
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subdomain
  title: subdomain
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: captcha
  title: captcha
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ip
  title: ip
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accessToken
  title: accessToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: refreshToken
  title: refreshToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: team
  title: team
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspace
  title: workspace
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workflowId
  title: workflowId
  required: false
  readable: true
  writeable: true

tokenId
type: Property
domain: ShopifyRegisterRequest
range: string

firstName
type: Property
domain: ShopifyRegisterRequest
range: string

lastName
type: Property
domain: ShopifyRegisterRequest
range: string

emailHash
type: Property
domain: ShopifyRegisterRequest
range: string

plainPassword
type: Property
domain: ShopifyRegisterRequest
range: string

team
type: Property
domain: ShopifyRegisterRequest
range: string
max cardinality: 1
range: Team

workspace
type: Property
domain: ShopifyRegisterRequest
range: string
max cardinality: 1
range: Workspace

subdomain
type: Property
domain: ShopifyRegisterRequest
range: string

captcha
type: Property
domain: ShopifyRegisterRequest
range: string

ip
type: Property
domain: ShopifyRegisterRequest
range: string

accessToken
type: Property
domain: ShopifyRegisterRequest
range: string

refreshToken
type: Property
domain: ShopifyRegisterRequest
range: string

user
type: Property
domain: ShopifyRegisterRequest
max cardinality: 1
range: User

workflowId
type: Property
domain: ShopifyRegisterRequest
range: string

ShopifyWorkspaceRequest
type: Class
title: ShopifyWorkspaceRequest
supported property: SupportedProperty
  property: tokenId
  title: tokenId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspaceId
  title: workspaceId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: teamId
  title: teamId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspaceId
  title: workspaceId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workflowId
  title: workflowId
  required: false
  readable: true
  writeable: true

tokenId
type: Property
domain: ShopifyWorkspaceRequest
range: string

workspaceId
type: Property
domain: ShopifyWorkspaceRequest
range: string

userId
type: Property
domain: ShopifyWorkspaceRequest
range: string

teamId
type: Property
domain: ShopifyWorkspaceRequest
range: string

workflowId
type: Property
domain: ShopifyWorkspaceRequest
range: string

KlaviyoWorkspaceRequest
type: Class
title: KlaviyoWorkspaceRequest
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspaceId
  title: workspaceId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: tokenId
  title: tokenId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: teamId
  title: teamId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspaceId
  title: workspaceId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workflowId
  title: workflowId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: redirectUrl
  title: redirectUrl
  required: false
  readable: true
  writeable: true

userId
type: Property
domain: KlaviyoWorkspaceRequest
range: string

workspaceId
type: Property
domain: KlaviyoWorkspaceRequest
range: string

code
type: Property
domain: KlaviyoWorkspaceRequest
range: string

tokenId
type: Property
domain: KlaviyoWorkspaceRequest
range: string

teamId
type: Property
domain: KlaviyoWorkspaceRequest
range: string

workflowId
type: Property
domain: KlaviyoWorkspaceRequest
range: string

redirectUrl
type: Property
domain: KlaviyoWorkspaceRequest
range: string

Review
type: Class
title: Review
supported operation: Retrieves Review resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Review resource.
  returns: Review

Workspace
type: Class
title: Workspace
supported property: SupportedProperty
  property: team
  title: team
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: defaultTrackingPage
  title: defaultTrackingPage
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipmentsCount
  title: shipmentsCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ordersCount
  title: ordersCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workflowsCount
  title: workflowsCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: preferredCarriers
  title: preferredCarriers
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: considerShipmentDelayed
  title: considerShipmentDelayed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workflowsOrder
  title: workflowsOrder
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: logo
  title: logo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailSettings
  title: emailSettings
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: widgets
  title: widgets
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: scheduledForDelete
  title: scheduledForDelete
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: members
  title: members
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ecommerceIntegrationType
  title: ecommerceIntegrationType
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Workspace resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Workspace resource.
  returns: Workspace
supported operation: Deletes the Workspace resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Workspace resource.
  returns: Nothing
supported operation: Replaces the Workspace resource.
  type: Operation
  type: ReplaceAction
  expects: Workspace
  method: PUT
  title: Replaces the Workspace resource.
  returns: Workspace
supported operation: Retrieves the collection of Shipment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Shipment resources.
  returns: Shipment
supported operation: Retrieves the collection of TrackingCheckpoint resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TrackingCheckpoint resources.
  returns: TrackingCheckpoint
supported operation: Retrieves the collection of ShipmentItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShipmentItem resources.
  returns: ShipmentItem
supported operation: Retrieves the collection of Order resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Order resources.
  returns: Order
supported operation: Retrieves the collection of OrderItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrderItem resources.
  returns: OrderItem
supported operation: Retrieves the collection of ShipmentItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShipmentItem resources.
  returns: ShipmentItem
supported operation: Retrieves the collection of Status resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Status resources.
  returns: Status
supported operation: Retrieves the collection of TrackingPage resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TrackingPage resources.
  returns: TrackingPage
supported operation: Retrieves the collection of EmailNotification resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EmailNotification resources.
  returns: EmailNotification
supported operation: Retrieves the collection of Note resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Note resources.
  returns: Note
supported operation: Retrieves the collection of Media resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Media resources.
  returns: Media
supported operation: Retrieves the collection of NoteReminder resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of NoteReminder resources.
  returns: NoteReminder
supported operation: Retrieves the collection of Workflow resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Workflow resources.
  returns: Workflow
supported operation: Retrieves the collection of WorkflowRun resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WorkflowRun resources.
  returns: WorkflowRun
supported operation: Retrieves the collection of Widget resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Widget resources.
  returns: Widget
supported operation: Retrieves the collection of WidgetLog resources.

team
type: Link
domain: Workspace
max cardinality: 1
range: Team

title
type: Property
domain: Workspace
range: string

defaultTrackingPage
type: Link
domain: Workspace
max cardinality: 1
range: TrackingPage

shipmentsCount
type: Property
domain: Workspace
range: integer

ordersCount
type: Property
domain: Workspace
range: integer

workflowsCount
type: Property
domain: Workspace
range: integer

preferredCarriers
type: Property
domain: Workspace
range: string

considerShipmentDelayed
type: Property
domain: Workspace
range: integer

workflowsOrder
type: Property
domain: Workspace

logo
type: Property
domain: Workspace
max cardinality: 1
range: Media

emailSettings
type: Property
domain: Workspace

widgets
type: Link
domain: Workspace
range: Widget

scheduledForDelete
type: Property
domain: Workspace
range: boolean

members
type: Property
domain: Workspace

ecommerceIntegrationType
type: Property
domain: Workspace
range: string

Credentials
type: Class
title: Credentials
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: team
  title: team
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Credentials resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Credentials resource.
  returns: Credentials
supported operation: Replaces the Credentials resource.
  type: Operation
  type: ReplaceAction
  expects: Credentials
  method: PUT
  title: Replaces the Credentials resource.
  returns: Credentials
supported operation: Deletes the Credentials resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Credentials resource.
  returns: Nothing

type
type: Property
domain: Credentials
range: string

team
type: Link
domain: Credentials
max cardinality: 1
range: Team

Workflow
type: Class
title: Workflow
supported property: SupportedProperty
  property: title
  title: title
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspace
  title: workspace
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: credentials
  title: credentials
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: notificationEmails
  title: notificationEmails
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastRunDate
  title: lastRunDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: period
  title: period
  required: true
  readable: true
  writeable: true
  description: applies only to out
supported property: SupportedProperty
  property: integration
  title: integration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: firstTimeSetupPassed
  title: firstTimeSetupPassed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: tags
  title: tags
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: integrationType
  title: integrationType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: passive
  title: passive
  required: false
  readable: true
  writeable: false
  description: On TrackMage side nothing happens. Workflow doesn't have an executor.
supported property: SupportedProperty
  property: remote
  title: remote
  required: false
  readable: true
  writeable: false
  description: The external system controls this integration.
supported property: SupportedProperty
  property: firstTimeSetupRequired
  title: firstTimeSetupRequired
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: runInProgress
  title: runInProgress
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Workflow resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Workflow resource.
  returns: Workflow
supported operation: Replaces the Workflow resource.
  type: Operation
  type: ReplaceAction
  expects: Workflow
  method: PUT
  title: Replaces the Workflow resource.
  returns: Workflow
supported operation: Deletes the Workflow resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Workflow resource.
  returns: Nothing
supported operation: Retrieves the collection of WorkflowRun resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WorkflowRun resources.
  returns: WorkflowRun

title
type: Property
domain: Workflow
range: string

type
type: Property
domain: Workflow
range: string

workspace
type: Link
domain: Workflow
max cardinality: 1
range: Workspace

credentials
type: Link
domain: Workflow
max cardinality: 1
range: Credentials

notificationEmails
type: Property
domain: Workflow
range: string

enabled
type: Property
domain: Workflow
range: boolean

lastRunDate
type: Property
domain: Workflow
range: dateTime

period
type: Property
domain: Workflow
range: string

integration
type: Property
domain: Workflow
max cardinality: 1
range: Workflow

firstTimeSetupPassed
type: Property
domain: Workflow
range: boolean

tags
type: Property
domain: Workflow
range: string

integrationType
type: Property
domain: Workflow
range: string

passive
type: Property
domain: Workflow
range: boolean

remote
type: Property
domain: Workflow
range: boolean

firstTimeSetupRequired
type: Property
domain: Workflow
range: boolean

runInProgress
type: Property
domain: Workflow
range: boolean

WorkflowRun
type: Class
title: WorkflowRun
supported property: SupportedProperty
  property: workflow
  title: workflow
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: duration
  title: duration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: log
  title: log
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: errors
  title: errors
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspace
  title: workspace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: deleted
  title: deleted
  required: false
  readable: true
  writeable: false
supported operation: Retrieves WorkflowRun resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves WorkflowRun resource.
  returns: WorkflowRun

workflow
type: Link
domain: WorkflowRun
max cardinality: 1
range: Workflow

createdAt
type: Property
domain: WorkflowRun
range: dateTime

updatedAt
type: Property
domain: WorkflowRun
range: dateTime

status
type: Property
domain: WorkflowRun
range: string

duration
type: Property
domain: WorkflowRun
range: integer

log
type: Property
domain: WorkflowRun
range: string

errors
type: Property
domain: WorkflowRun
range: string

deletedAt
type: Property
domain: WorkflowRun
range: dateTime

workspace
type: Link
domain: WorkflowRun
max cardinality: 1
range: Workspace

deleted
type: Property
domain: WorkflowRun
range: boolean

Address
type: Class
title: Address

Shipment
type: Class
title: Shipment
supported property: SupportedProperty
  property: trackingNumber
  title: trackingNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: trackingStatus
  title: trackingStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: orderNumbers
  title: orderNumbers
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: daysInTransit
  title: daysInTransit
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: daysInIdle
  title: daysInIdle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: originCarrier
  title: originCarrier
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: destinationCarrier
  title: destinationCarrier
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: originCountry
  title: originCountry
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: destinationCountry
  title: destinationCountry
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: originCountryIso2
  title: originCountryIso2
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: destinationCountryIso2
  title: destinationCountryIso2
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shippedAt
  title: shippedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: expectedDeliveryDate
  title: expectedDeliveryDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastStatusUpdate
  title: lastStatusUpdate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: daysSinceLastCheckpoint
  title: daysSinceLastCheckpoint
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspace
  title: workspace
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: review
  title: review
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: reviewTotalScore
  title: reviewTotalScore
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: orders
  title: orders
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipmentItems
  title: shipmentItems
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalSourceIntegration
  title: externalSourceIntegration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalSourceSyncId
  title: externalSourceSyncId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fulfillmentIntegration
  title: fulfillmentIntegration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fulfillmentSyncId
  title: fulfillmentSyncId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: address
  title: address
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipmentStatus
  title: shipmentStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalSourceIntegrationType
  title: externalSourceIntegrationType
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Shipment resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Shipment resource.
  returns: Shipment
supported operation: Deletes the Shipment resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Shipment resource.
  returns: Nothing
supported operation: Replaces the Shipment resource.
supported operation: Retrieves the collection of TrackingCheckpoint resources.
supported operation: Retrieves the collection of ShipmentItem resources.

trackingNumber
type: Property
domain: Shipment
range: string

trackingStatus
type: Property
domain: Shipment
range: string

orderNumbers
type: Property
domain: Shipment
range: string

phoneNumber
type: Property
domain: Shipment
range: string

daysInTransit
type: Property
domain: Shipment
range: integer

daysInIdle
type: Property
domain: Shipment
range: integer

originCarrier
type: Property
domain: Shipment
range: string

destinationCarrier
type: Property
domain: Shipment
range: string

originCountry
type: Property
domain: Shipment
range: string

destinationCountry
type: Property
domain: Shipment
range: string

originCountryIso2
type: Property
domain: Shipment
range: string

destinationCountryIso2
type: Property
domain: Shipment
range: string

shippedAt
type: Property
domain: Shipment
range: dateTime

expectedDeliveryDate
type: Property
domain: Shipment
range: dateTime

createdAt
type: Property
domain: Shipment
range: dateTime

updatedAt
type: Property
domain: Shipment
range: dateTime

lastStatusUpdate
type: Property
domain: Shipment
range: dateTime

daysSinceLastCheckpoint
type: Property
domain: Shipment
range: integer

workspace
type: Link
domain: Shipment
max cardinality: 1
range: Workspace

review
type: Link
domain: Shipment
max cardinality: 1
range: Review

reviewTotalScore
type: Property
domain: Shipment
range: decimal

orders
type: Link
domain: Shipment
range: Order

shipmentItems
type: Link
domain: Shipment
range: ShipmentItem

externalSourceIntegration
type: Link
domain: Shipment
max cardinality: 1
range: Workflow

externalSourceSyncId
type: Property
domain: Shipment
range: string

fulfillmentIntegration
type: Link
domain: Shipment
max cardinality: 1
range: Workflow

fulfillmentSyncId
type: Property
domain: Shipment
range: string

address
type: Property
domain: Shipment
max cardinality: 1
range: Address

shipmentStatus
type: Property
domain: Shipment
max cardinality: 1
range: Status

externalSourceIntegrationType
type: Property
domain: Shipment
range: string

TrackingCheckpoint
type: Class
title: TrackingCheckpoint
supported property: SupportedProperty
  property: shipment
  title: shipment
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: checkpointDate
  title: checkpointDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: info
  title: info
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: location
  title: location
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: rel
  title: rel
  required: false
  readable: true
  writeable: true
  description: carrier affiliation
supported operation: Retrieves TrackingCheckpoint resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves TrackingCheckpoint resource.
  returns: TrackingCheckpoint

shipment
type: Link
domain: TrackingCheckpoint
max cardinality: 1
range: Shipment

checkpointDate
type: Property
domain: TrackingCheckpoint
range: dateTime

info
type: Property
domain: TrackingCheckpoint
range: string

location
type: Property
domain: TrackingCheckpoint
range: string

rel
type: Property
domain: TrackingCheckpoint
range: string

OauthClient
type: Class
title: OauthClient
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: secret
  title: secret
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: redirectUris
  title: redirectUris
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: publicId
  title: publicId
  required: false
  readable: true
  writeable: false
  description: {@inheritdoc}
supported operation: Retrieves OauthClient resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves OauthClient resource.
  returns: OauthClient
supported operation: Deletes the OauthClient resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the OauthClient resource.
  returns: Nothing

name
type: Property
domain: OauthClient
range: string

user
type: Link
domain: OauthClient
max cardinality: 1
range: User

secret
type: Property
domain: OauthClient
range: string

redirectUris
type: Property
domain: OauthClient

publicId
type: Property
domain: OauthClient

Media
type: Class
title: Media
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: file
  title: file
  required: true
  readable: false
  writeable: true
supported property: SupportedProperty
  property: fileName
  title: fileName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: fileOriginalName
  title: fileOriginalName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fileMimeType
  title: fileMimeType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: fileSize
  title: fileSize
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: thumbnail
  title: thumbnail
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: thumbnailName
  title: thumbnailName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: filePath
  title: filePath
  required: false
  readable: true
  writeable: false
  description: https://s3-test.trackmage.com/media/a4f29b34-aa67-4e68-a7c8-f1c2e081979e/5dfa6dfcc161f_cats.png TODO: prepend this with PublicUrlPlugin in a normalizer, and remove IMG_URL on frontend.
supported property: SupportedProperty
  property: thumbnailPath
  title: thumbnailPath
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Media resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Media resource.
  returns: Media

user
type: Link
domain: Media
max cardinality: 1
range: User

file
type: Property
domain: Media
domain: Import

fileName
type: Property
domain: Media
range: string

fileOriginalName
type: Property
domain: Media
range: string

fileMimeType
type: Property
domain: Media
range: string

fileSize
type: Property
domain: Media
range: integer

thumbnail
type: Property
domain: Media

thumbnailName
type: Property
domain: Media
range: string

filePath
type: Property
domain: Media
range: string

thumbnailPath
type: Property
domain: Media
range: string

Import
type: Class
title: Import
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: workspace
  title: workspace
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: entityType
  title: entityType
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: file
  title: file
  required: true
  readable: false
  writeable: true
supported property: SupportedProperty
  property: fileOriginalName
  title: fileOriginalName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fileMimeType
  title: fileMimeType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: fileSize
  title: fileSize
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Import resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Import resource.
  returns: Import

user
type: Link
domain: Import
max cardinality: 1
range: User

workspace
type: Link
domain: Import
max cardinality: 1
range: Workspace

entityType
type: Property
domain: Import
range: string

status
type: Property
domain: Import
range: string

fileOriginalName
type: Property
domain: Import
range: string

fileMimeType
type: Property
domain: Import
range: string

fileSize
type: Property
domain: Import
range: integer

TrackingPage
type: Class
title: TrackingPage
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: reviewsEnabled
  title: reviewsEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspace
  title: workspace
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subdomain
  title: subdomain
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: domain
  title: domain
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: domainEnabled
  title: domainEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sidebarField
  title: sidebarField
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: trackingNumberField
  title: trackingNumberField
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: builder
  title: builder
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: dropshipperSettings
  title: dropshipperSettings
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customThemeId
  title: customThemeId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: usedByDefault
  title: usedByDefault
  required: false
  readable: true
  writeable: false
supported operation: Retrieves TrackingPage resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves TrackingPage resource.
  returns: TrackingPage
supported operation: Replaces the TrackingPage resource.
  type: Operation
  type: ReplaceAction
  expects: TrackingPage
  method: PUT
  title: Replaces the TrackingPage resource.
  returns: TrackingPage
supported operation: Deletes the TrackingPage resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the TrackingPage resource.
  returns: Nothing
supported operation: Retrieves TrackingPage resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves TrackingPage resource.
  returns: TrackingPage
supported operation: Creates a TrackingPage resource.
  type: Operation
  type: CreateAction
  expects: TrackingPage
  method: POST
  title: Creates a TrackingPage resource.
  returns: TrackingPage

enabled
type: Property
domain: TrackingPage
range: boolean

reviewsEnabled
type: Property
domain: TrackingPage
range: boolean

title
type: Property
domain: TrackingPage
range: string

workspace
type: Link
domain: TrackingPage
max cardinality: 1
range: Workspace

subdomain
type: Property
domain: TrackingPage
range: string

domain
type: Property
domain: TrackingPage
range: string

domainEnabled
type: Property
domain: TrackingPage
range: boolean

sidebarField
type: Property
domain: TrackingPage
range: string

trackingNumberField
type: Property
domain: TrackingPage
range: string

builder
type: Property
domain: TrackingPage

dropshipperSettings
type: Property
domain: TrackingPage

customThemeId
type: Property
domain: TrackingPage
range: string

usedByDefault
type: Property
domain: TrackingPage
range: boolean

Field
type: Class
title: Field
supported property: SupportedProperty
  property: workspace
  title: workspace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fieldType
  title: fieldType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: readonly
  title: readonly
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: sorting
  title: sorting
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: selectOptions
  title: selectOptions
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: visibleExpr
  title: visibleExpr
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: validation
  title: validation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: default
  title: default
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: placeholder
  title: placeholder
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: refreshOnChange
  title: refreshOnChange
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: helperText
  title: helperText
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: tags
  title: tags
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: options
  title: options
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: primary
  title: primary
  required: false
  readable: true
  writeable: false
  description: Primary field means defined statically. Custom field is from EAV
supported operation: Retrieves Field resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Field resource.
  returns: Field
supported operation: Replaces the Field resource.
  type: Operation
  type: ReplaceAction
  expects: Field
  method: PUT
  title: Replaces the Field resource.
  returns: Field
supported operation: Deletes the Field resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Field resource.
  returns: Nothing

workspace
type: Link
domain: Field
max cardinality: 1
range: Workspace

entity
type: Property
domain: Field
range: string

title
type: Property
domain: Field
range: string

fieldType
type: Property
domain: Field
range: string

readonly
type: Property
domain: Field
range: boolean

sorting
type: Property
domain: Field
range: boolean

selectOptions
type: Property
domain: Field

visibleExpr
type: Property
domain: Field
range: string

validation
type: Property
domain: Field
range: string

default
type: Property
domain: Field
range: string

placeholder
type: Property
domain: Field
range: string

refreshOnChange
type: Property
domain: Field
range: boolean

helperText
type: Property
domain: Field
range: string

tags
type: Property
domain: Field

options
type: Property
domain: Field

primary
type: Property
domain: Field
range: boolean

EmailNotification
type: Class
title: EmailNotification
supported property: SupportedProperty
  property: event
  title: event
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: system
  title: system
  required: false
  readable: true
  writeable: true
  description: Pre-created
supported property: SupportedProperty
  property: condition
  title: condition
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: scheduleDelay
  title: scheduleDelay
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspace
  title: workspace
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cc
  title: cc
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: bcc
  title: bcc
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subject
  title: subject
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: body
  title: body
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastEmailSentAt
  title: lastEmailSentAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: trackingPage
  title: trackingPage
  required: false
  readable: true
  writeable: true
supported operation: Retrieves EmailNotification resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves EmailNotification resource.
  returns: EmailNotification
supported operation: Replaces the EmailNotification resource.
  type: Operation
  type: ReplaceAction
  expects: EmailNotification
  method: PUT
  title: Replaces the EmailNotification resource.
  returns: EmailNotification
supported operation: Deletes the EmailNotification resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the EmailNotification resource.
  returns: Nothing

event
type: Property
domain: EmailNotification
range: string

system
type: Property
domain: EmailNotification
range: boolean

condition
type: Property
domain: EmailNotification
range: string

scheduleDelay
type: Property
domain: EmailNotification
range: string

enabled
type: Property
domain: EmailNotification
range: boolean

workspace
type: Link
domain: EmailNotification
max cardinality: 1
range: Workspace

title
type: Property
domain: EmailNotification
range: string

cc
type: Property
domain: EmailNotification
range: string

bcc
type: Property
domain: EmailNotification
range: string

subject
type: Property
domain: EmailNotification
range: string

body
type: Property
domain: EmailNotification
range: string

createdAt
type: Property
domain: EmailNotification
range: dateTime

lastEmailSentAt
type: Property
domain: EmailNotification
range: dateTime

trackingPage
type: Link
domain: EmailNotification
max cardinality: 1
range: TrackingPage

FieldsLayout
type: Class
title: FieldsLayout
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fields
  title: fields
  required: false
  readable: true
  writeable: true
supported operation: Retrieves FieldsLayout resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves FieldsLayout resource.
  returns: FieldsLayout

title
type: Property
domain: FieldsLayout
range: string

fields
type: Property
domain: FieldsLayout

Carrier
type: Class
title: Carrier
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phone
  title: phone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: url
  title: url
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: image
  title: image
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: countryIso2Codes
  title: countryIso2Codes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Carrier resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Carrier resource.
  returns: Carrier

code
type: Property
domain: Carrier
range: string

name
type: Property
domain: Carrier
range: string

phone
type: Property
domain: Carrier
range: string

url
type: Property
domain: Carrier
range: string

image
type: Property
domain: Carrier
range: string

countryIso2Codes
type: Property
domain: Carrier
range: string

description
type: Property
domain: Carrier
range: string

TrackingStatus
type: Class
title: TrackingStatus
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported operation: Retrieves TrackingStatus resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves TrackingStatus resource.
  returns: TrackingStatus

code
type: Property
domain: TrackingStatus
range: string

title
type: Property
domain: TrackingStatus
range: string

description
type: Property
domain: TrackingStatus
range: string

Timezone
type: Class
title: Timezone
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Timezone resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Timezone resource.
  returns: Timezone

name
type: Property
domain: Timezone
range: string

Country
type: Class
title: Country
supported property: SupportedProperty
  property: states
  title: states
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: preferred
  title: preferred
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: stateful
  title: stateful
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Country resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Country resource.
  returns: Country
supported operation: Retrieves the collection of State resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of State resources.
  returns: State

states
type: Link
domain: Country
range: State

code
type: Property
domain: Country
range: string

name
type: Property
domain: Country
range: string

preferred
type: Property
domain: Country
range: boolean

stateful
type: Property
domain: Country
range: boolean

State
type: Class
title: State
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported operation: Retrieves State resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves State resource.
  returns: State

code
type: Property
domain: State
range: string

name
type: Property
domain: State
range: string

EntityType
type: Class
title: EntityType
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: tags
  title: tags
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fieldsLayout
  title: fieldsLayout
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: placeholder
  title: placeholder
  required: false
  readable: true
  writeable: true
  description: If true means it's used in UI only for displaying placeholderTemplate
supported property: SupportedProperty
  property: placeholderTemplate
  title: placeholderTemplate
  required: false
  readable: true
  writeable: true
  description: HTML
supported property: SupportedProperty
  property: field
  title: field
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspaceId
  title: workspaceId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: statusId
  title: statusId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ids
  title: ids
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspaceId
  title: workspaceId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ids
  title: ids
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true
supported operation: Retrieves EntityType resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves EntityType resource.
  returns: EntityType

id
type: Property
domain: EntityType
range: string

entity
type: Property
domain: EntityType
range: string

type
type: Property
domain: EntityType
range: string

tags
type: Property
domain: EntityType

title
type: Property
domain: EntityType
range: string

fieldsLayout
type: Property
domain: EntityType

placeholder
type: Property
domain: EntityType
range: boolean

placeholderTemplate
type: Property
domain: EntityType
range: string

field
type: Property
domain: EntityType
max cardinality: 1
range: Field

userId
type: Property
domain: EntityType
range: string

workspaceId
type: Property
domain: EntityType
range: string

statusId
type: Property
domain: EntityType
range: string

ids
type: Property
domain: EntityType
range: string

ChangeStatusBatchAsyncRequest
type: Class
title: ChangeStatusBatchAsyncRequest
supported property: SupportedProperty
  property: workspaceId
  title: workspaceId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: statusId
  title: statusId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ids
  title: ids
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true

workspaceId
type: Property
domain: ChangeStatusBatchAsyncRequest
range: string

entity
type: Property
domain: ChangeStatusBatchAsyncRequest
range: string

statusId
type: Property
domain: ChangeStatusBatchAsyncRequest
range: string

ids
type: Property
domain: ChangeStatusBatchAsyncRequest

userId
type: Property
domain: ChangeStatusBatchAsyncRequest
range: string

Notification
type: Class
title: Notification
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: tag
  title: tag
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: data
  title: data
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: unread
  title: unread
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: workspace
  title: workspace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: team
  title: team
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Notification resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Notification resource.
  returns: Notification
supported operation: Replaces the Notification resource.
  type: Operation
  type: ReplaceAction
  expects: Notification
  method: PUT
  title: Replaces the Notification resource.
  returns: Notification

user
type: Link
domain: Notification
max cardinality: 1
range: User

tag
type: Property
domain: Notification
range: string

message
type: Property
domain: Notification
range: string

data
type: Property
domain: Notification

unread
type: Property
domain: Notification
range: boolean

createdAt
type: Property
domain: Notification
range: dateTime

updatedAt
type: Property
domain: Notification
range: dateTime

workspace
type: Link
domain: Notification
max cardinality: 1
range: Workspace

team
type: Link
domain: Notification
max cardinality: 1
range: Team

Order
type: Class
title: Order
supported property: SupportedProperty
  property: workspace
  title: workspace
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: orderNumber
  title: orderNumber
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalSourceIntegration
  title: externalSourceIntegration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalSourceSyncId
  title: externalSourceSyncId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalSourceUrl
  title: externalSourceUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subtotal
  title: subtotal
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: total
  title: total
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: currency
  title: currency
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: orderStatus
  title: orderStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: orderType
  title: orderType
  required: true
  readable: true
  writeable: true
  description: customer|vendor
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipments
  title: shipments
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shippingAddress
  title: shippingAddress
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: billingAddress
  title: billingAddress
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fulfillmentStatus
  title: fulfillmentStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: shipmentsWithoutTrackingCount
  title: shipmentsWithoutTrackingCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: readonly
  title: readonly
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: externalSourceIntegrationType
  title: externalSourceIntegrationType
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Order resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Order resource.
  returns: Order
supported operation: Replaces the Order resource.
  type: Operation
  type: ReplaceAction
  expects: Order
  method: PUT
  title: Replaces the Order resource.
  returns: Order
supported operation: Deletes the Order resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Order resource.
  returns: Nothing
supported operation: Retrieves the collection of OrderItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrderItem resources.
  returns: OrderItem
supported operation: Retrieves the collection of ShipmentItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShipmentItem resources.
  returns: ShipmentItem

workspace
type: Link
domain: Order
max cardinality: 1
range: Workspace

orderNumber
type: Property
domain: Order
range: string

externalSourceIntegration
type: Link
domain: Order
max cardinality: 1
range: Workflow

externalSourceSyncId
type: Property
domain: Order
range: string

externalSourceUrl
type: Property
domain: Order
range: string

subtotal
type: Property
domain: Order
range: string

total
type: Property
domain: Order
range: string

currency
type: Property
domain: Order
range: string

orderStatus
type: Property
domain: Order
max cardinality: 1
range: Status

orderType
type: Property
domain: Order
range: string

phoneNumber
type: Property
domain: Order
range: string

createdAt
type: Property
domain: Order
range: dateTime

updatedAt
type: Property
domain: Order
range: dateTime

shipments
type: Link
domain: Order
range: Shipment

shippingAddress
type: Property
domain: Order
max cardinality: 1
range: Address

billingAddress
type: Property
domain: Order
max cardinality: 1
range: Address

fulfillmentStatus
type: Property
domain: Order
range: string

shipmentsWithoutTrackingCount
type: Property
domain: Order
range: integer

readonly
type: Property
domain: Order
range: boolean

externalSourceIntegrationType
type: Property
domain: Order
range: string

OrderItem
type: Class
title: OrderItem
supported property: SupportedProperty
  property: order
  title: order
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: productName
  title: productName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: productSku
  title: productSku
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: productOptions
  title: productOptions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: qty
  title: qty
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: price
  title: price
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: rowTotal
  title: rowTotal
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalProductId
  title: externalProductId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalSourceSyncId
  title: externalSourceSyncId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalSourceIntegration
  title: externalSourceIntegration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: product
  title: product
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: productVariant
  title: productVariant
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: url
  title: imageUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fulfilledQty
  title: fulfilledQty
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: refundedQty
  title: refundedQty
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalProductLink
  title: externalProductLink
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: currency
  title: currency
  required: false
  readable: true
  writeable: false
supported operation: Retrieves OrderItem resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves OrderItem resource.
  returns: OrderItem
supported operation: Replaces the OrderItem resource.
  type: Operation
  type: ReplaceAction
  expects: OrderItem
  method: PUT
  title: Replaces the OrderItem resource.
  returns: OrderItem
supported operation: Deletes the OrderItem resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the OrderItem resource.
  returns: Nothing
supported operation: Retrieves the collection of ShipmentItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShipmentItem resources.
  returns: ShipmentItem

order
type: Link
domain: OrderItem
max cardinality: 1
range: Order

productName
type: Property
domain: OrderItem
range: string

productSku
type: Property
domain: OrderItem
range: string

productOptions
type: Property
domain: OrderItem
range: string

qty
type: Property
domain: OrderItem
range: integer

price
type: Property
domain: OrderItem
range: string

rowTotal
type: Property
domain: OrderItem
range: string

externalProductId
type: Property
domain: OrderItem
range: string

externalSourceSyncId
type: Property
domain: OrderItem
range: string

externalSourceIntegration
type: Link
domain: OrderItem
max cardinality: 1
range: Workflow

product
type: Link
domain: OrderItem
max cardinality: 1
range: Product

productVariant
type: Link
domain: OrderItem
max cardinality: 1
range: ProductVariant

fulfilledQty
type: Property
domain: OrderItem
range: integer

refundedQty
type: Property
domain: OrderItem
range: integer

externalProductLink
type: Property
domain: OrderItem
range: string

currency
type: Property
domain: OrderItem
range: string

ShipmentItem
type: Class
title: ShipmentItem
supported property: SupportedProperty
  property: shipment
  title: shipment
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: orderItem
  title: orderItem
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: qty
  title: qty
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalSourceSyncId
  title: externalSourceSyncId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalSourceIntegration
  title: externalSourceIntegration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fulfillmentIntegration
  title: fulfillmentIntegration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fulfillmentSyncId
  title: fulfillmentSyncId
  required: false
  readable: true
  writeable: true
supported operation: Retrieves ShipmentItem resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ShipmentItem resource.
  returns: ShipmentItem
supported operation: Replaces the ShipmentItem resource.
  type: Operation
  type: ReplaceAction
  expects: ShipmentItem
  method: PUT
  title: Replaces the ShipmentItem resource.
  returns: ShipmentItem
supported operation: Deletes the ShipmentItem resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ShipmentItem resource.
  returns: Nothing

shipment
type: Link
domain: ShipmentItem
max cardinality: 1
range: Shipment

orderItem
type: Link
domain: ShipmentItem
max cardinality: 1
range: OrderItem

qty
type: Property
domain: ShipmentItem
range: integer

externalSourceSyncId
type: Property
domain: ShipmentItem
range: string

externalSourceIntegration
type: Link
domain: ShipmentItem
max cardinality: 1
range: Workflow

fulfillmentIntegration
type: Link
domain: ShipmentItem
max cardinality: 1
range: Workflow

fulfillmentSyncId
type: Property
domain: ShipmentItem
range: string

Status
type: Class
title: Status
supported property: SupportedProperty
  property: workspace
  title: workspace
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: entity
  title: entity
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Status resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Status resource.
  returns: Status
supported operation: Replaces the Status resource.
  type: Operation
  type: ReplaceAction
  expects: Status
  method: PUT
  title: Replaces the Status resource.
  returns: Status
supported operation: Deletes the Status resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Status resource.
  returns: Nothing

workspace
type: Link
domain: Status
max cardinality: 1
range: Workspace

entity
type: Property
domain: Status
range: string

code
type: Property
domain: Status
range: string

title
type: Property
domain: Status
range: string

description
type: Property
domain: Status
range: string

Note
type: Class
title: Note
supported property: SupportedProperty
  property: workspace
  title: workspace
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: entity
  title: entity
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: entityId
  title: entityId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: comment
  title: comment
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: attachments
  title: attachments
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: reminders
  title: reminders
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userPhoto
  title: userPhoto
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: userFullName
  title: userFullName
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Note resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Note resource.
  returns: Note
supported operation: Replaces the Note resource.
  type: Operation
  type: ReplaceAction
  expects: Note
  method: PUT
  title: Replaces the Note resource.
  returns: Note
supported operation: Deletes the Note resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Note resource.
  returns: Nothing
supported operation: Retrieves the collection of Media resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Media resources.
  returns: Media
supported operation: Retrieves the collection of NoteReminder resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of NoteReminder resources.
  returns: NoteReminder

workspace
type: Link
domain: Note
max cardinality: 1
range: Workspace

entity
type: Property
domain: Note
range: string

entityId
type: Property
domain: Note
range: string

user
type: Link
domain: Note
max cardinality: 1
range: User

comment
type: Property
domain: Note
range: string

createdAt
type: Property
domain: Note
range: dateTime

attachments
type: Property
domain: Note
range: Media

reminders
type: Property
domain: Note
range: NoteReminder

userPhoto
type: Property
domain: Note
range: string

userFullName
type: Property
domain: Note
range: string

NoteReminder
type: Class
title: NoteReminder
supported property: SupportedProperty
  property: note
  title: note
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userIds
  title: userIds
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: notifyAt
  title: notifyAt
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: notified
  title: notified
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: deleted
  title: deleted
  required: false
  readable: true
  writeable: false
supported operation: Retrieves NoteReminder resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves NoteReminder resource.
  returns: NoteReminder

note
type: Link
domain: NoteReminder
max cardinality: 1
range: Note

userIds
type: Property
domain: NoteReminder

notifyAt
type: Property
domain: NoteReminder
range: dateTime

notified
type: Property
domain: NoteReminder
range: boolean

deletedAt
type: Property
domain: NoteReminder
range: dateTime

deleted
type: Property
domain: NoteReminder
range: boolean

Product
type: Class
title: Product
supported property: SupportedProperty
  property: team
  title: team
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sku
  title: sku
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: url
  title: originUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: imageUrl
  title: imageUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalSourceIntegration
  title: externalSourceIntegration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalSourceSyncId
  title: externalSourceSyncId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: productVariants
  title: productVariants
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Product resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Product resource.
  returns: Product
supported operation: Replaces the Product resource.
  type: Operation
  type: ReplaceAction
  expects: Product
  method: PUT
  title: Replaces the Product resource.
  returns: Product
supported operation: Deletes the Product resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Product resource.
  returns: Nothing
supported operation: Retrieves the collection of ProductVariant resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductVariant resources.
  returns: ProductVariant

team
type: Link
domain: Product
max cardinality: 1
range: Team

name
type: Property
domain: Product
range: string

sku
type: Property
domain: Product
range: string

imageUrl
type: Property
domain: Product
range: string

externalSourceIntegration
type: Link
domain: Product
max cardinality: 1
range: Workflow

externalSourceSyncId
type: Property
domain: Product
range: string

productVariants
type: Link
domain: Product
range: ProductVariant

ProductVariant
type: Class
title: ProductVariant
supported property: SupportedProperty
  property: team
  title: team
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sku
  title: sku
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: url
  title: imageUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: product
  title: product
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: price
  title: price
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalSourceIntegration
  title: externalSourceIntegration
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: externalSourceSyncId
  title: externalSourceSyncId
  required: false
  readable: true
  writeable: true
supported operation: Retrieves ProductVariant resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ProductVariant resource.
  returns: ProductVariant
supported operation: Replaces the ProductVariant resource.
  type: Operation
  type: ReplaceAction
  expects: ProductVariant
  method: PUT
  title: Replaces the ProductVariant resource.
  returns: ProductVariant
supported operation: Deletes the ProductVariant resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the ProductVariant resource.
  returns: Nothing

team
type: Link
domain: ProductVariant
max cardinality: 1
range: Team

sku
type: Property
domain: ProductVariant
range: string

product
type: Link
domain: ProductVariant
max cardinality: 1
range: Product

price
type: Property
domain: ProductVariant
range: string

externalSourceIntegration
type: Link
domain: ProductVariant
max cardinality: 1
range: Workflow

externalSourceSyncId
type: Property
domain: ProductVariant
range: string

LookupInvitationTeamNameRequest
type: Class
title: LookupInvitationTeamNameRequest
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: code
  title: code
  required: true
  readable: true
  writeable: true

code
type: Property
domain: LookupInvitationTeamNameRequest
range: string

Widget
type: Class
title: Widget
supported property: SupportedProperty
  property: title
  title: title
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspace
  title: workspace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: options
  title: options
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: integration
  title: integration
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Widget resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Widget resource.
  returns: Widget
supported operation: Replaces the Widget resource.
  type: Operation
  type: ReplaceAction
  expects: Widget
  method: PUT
  title: Replaces the Widget resource.
  returns: Widget
supported operation: Deletes the Widget resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Widget resource.
  returns: Nothing
supported operation: Retrieves the collection of WidgetLog resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WidgetLog resources.
  returns: WidgetLog

title
type: Property
domain: Widget
range: string

type
type: Property
domain: Widget
range: string

enabled
type: Property
domain: Widget
range: boolean

workspace
type: Link
domain: Widget
max cardinality: 1
range: Workspace

options
type: Property
domain: Widget

createdAt
type: Property
domain: Widget
range: dateTime

updatedAt
type: Property
domain: Widget
range: dateTime

integration
type: Link
domain: Widget
max cardinality: 1
range: Workflow

WidgetLog
type: Class
title: WidgetLog
supported property: SupportedProperty
  property: widget
  title: widget
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: info
  title: info
  required: false
  readable: true
  writeable: true
supported operation: Retrieves WidgetLog resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves WidgetLog resource.
  returns: WidgetLog

widget
type: Link
domain: WidgetLog
max cardinality: 1
range: Widget

createdAt
type: Property
domain: WidgetLog
range: dateTime

info
type: Property
domain: WidgetLog
range: string

ExportEntityRequest
type: Class
title: ExportEntityRequest
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: workspaceId
  title: workspaceId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: entity
  title: entity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: params
  title: params
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: link
  title: link
  required: false
  readable: true
  writeable: true

userId
type: Property
domain: ExportEntityRequest
range: string

workspaceId
type: Property
domain: ExportEntityRequest
range: string

entity
type: Property
domain: ExportEntityRequest
range: string

params
type: Property
domain: ExportEntityRequest

message
type: Property
domain: ExportEntityRequest
range: string

link
type: Property
domain: ExportEntityRequest
range: string

MarkNotificationsAsReadRequest
type: Class
title: MarkNotificationsAsReadRequest
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ids
  title: ids
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: all
  title: all
  required: false
  readable: true
  writeable: true

userId
type: Property
domain: MarkNotificationsAsReadRequest
range: string

ids
type: Property
domain: MarkNotificationsAsReadRequest

all
type: Property
domain: MarkNotificationsAsReadRequest
range: boolean

SubscribeTeamOnTrialRequest
type: Class
title: SubscribeTeamOnTrialRequest
supported property: SupportedProperty
  property: userId
  title: userId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: teamId
  title: teamId
  required: false
  readable: true
  writeable: true

userId
type: Property
domain: SubscribeTeamOnTrialRequest
range: string

teamId
type: Property
domain: SubscribeTeamOnTrialRequest
range: string

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of User resources
  title: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Team resources
  title: The collection of Team resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of TeamMember resources
  title: The collection of TeamMember resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of WorkspaceMember resources
  title: The collection of WorkspaceMember resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of UserSignupRequest resources
  title: The collection of UserSignupRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of UserVerifyEmailRequest resources
  title: The collection of UserVerifyEmailRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of UserResendEmailRequest resources
  title: The collection of UserResendEmailRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ForgotPasswordSendEmailRequest resources
  title: The collection of ForgotPasswordSendEmailRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ApplyWorkspacePermissionsBatchRequest resources
  title: The collection of ApplyWorkspacePermissionsBatchRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of GenerateTrackingPageLinkRequest resources
  title: The collection of GenerateTrackingPageLinkRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of GenerateTrackingPageLinksRequest resources
  title: The collection of GenerateTrackingPageLinksRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of GenerateThemeRequest resources
  title: The collection of GenerateThemeRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CheckTrackingStatusesRequest resources
  title: The collection of CheckTrackingStatusesRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CheckTrackingStatusesAsyncRequest resources
  title: The collection of CheckTrackingStatusesAsyncRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of PostReviewRequest resources
  title: The collection of PostReviewRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of HandleChargebeeWebhookRequest resources
  title: The collection of HandleChargebeeWebhookRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CreateChargebeeSessionRequest resources
  title: The collection of CreateChargebeeSessionRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CreateChargebeeHostedPageCheckoutRequest resources
  title: The collection of CreateChargebeeHostedPageCheckoutRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of GetChargebeeSubscriptionEstimateRequest resources
  title: The collection of GetChargebeeSubscriptionEstimateRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of DowngradeChargebeeSubscriptionRequest resources
  title: The collection of DowngradeChargebeeSubscriptionRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CheckoutShopifySubscriptionRequest resources
  title: The collection of CheckoutShopifySubscriptionRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of VerifyDomainRequest resources
  title: The collection of VerifyDomainRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of VerifyProductsFeedRequest resources
  title: The collection of VerifyProductsFeedRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ImportProductsFeedRequest resources
  title: The collection of ImportProductsFeedRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of LoadDatabaseFixturesRequest resources
  title: The collection of LoadDatabaseFixturesRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of SubdomainCheckRequest resources
  title: The collection of SubdomainCheckRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ShopifyRegisterRequest resources
  title: The collection of ShopifyRegisterRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ShopifyWorkspaceRequest resources
  title: The collection of ShopifyWorkspaceRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of KlaviyoWorkspaceRequest resources
  title: The collection of KlaviyoWorkspaceRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Workspace resources
  title: The collection of Workspace resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Credentials resources
  title: The collection of Credentials resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Workflow resources
  title: The collection of Workflow resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of WorkflowRun resources
  title: The collection of WorkflowRun resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Shipment resources
  title: The collection of Shipment resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of TrackingCheckpoint resources
  title: The collection of TrackingCheckpoint resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of OauthClient resources
  title: The collection of OauthClient resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Media resources
  title: The collection of Media resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Import resources
  title: The collection of Import resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of TrackingPage resources
  title: The collection of TrackingPage resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Field resources
  title: The collection of Field resources
  readable: true
  writeable: false
supported operation: The API entrypoint.

The collection of User resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Retrieves the collection of TeamMember resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TeamMember resources.
  returns: TeamMember
supported operation: Retrieves the collection of Notification resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Notification resources.
  returns: Notification

The collection of Team resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Team
supported operation: Retrieves the collection of Team resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Team resources.
  returns: Collection
supported operation: Creates a Team resource.
  type: Operation
  type: CreateAction
  expects: Team
  method: POST
  title: Creates a Team resource.
  returns: Team
supported operation: Retrieves the collection of Workspace resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Workspace resources.
  returns: Workspace
supported operation: Retrieves the collection of Shipment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Shipment resources.
  returns: Shipment
supported operation: Retrieves the collection of TrackingCheckpoint resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TrackingCheckpoint resources.
  returns: TrackingCheckpoint
supported operation: Retrieves the collection of ShipmentItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShipmentItem resources.
  returns: ShipmentItem
supported operation: Retrieves the collection of Order resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Order resources.
  returns: Order
supported operation: Retrieves the collection of OrderItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrderItem resources.
  returns: OrderItem
supported operation: Retrieves the collection of ShipmentItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShipmentItem resources.
  returns: ShipmentItem
supported operation: Retrieves the collection of Status resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Status resources.
  returns: Status
supported operation: Retrieves the collection of TrackingPage resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TrackingPage resources.
  returns: TrackingPage
supported operation: Retrieves the collection of EmailNotification resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EmailNotification resources.
  returns: EmailNotification
supported operation: Retrieves the collection of Note resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Note resources.
  returns: Note
supported operation: Retrieves the collection of Media resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Media resources.
  returns: Media
supported operation: Retrieves the collection of NoteReminder resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of NoteReminder resources.
  returns: NoteReminder
supported operation: Retrieves the collection of Workflow resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Workflow resources.
  returns: Workflow
supported operation: Retrieves the collection of WorkflowRun resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WorkflowRun resources.
  returns: WorkflowRun
supported operation: Retrieves the collection of Widget resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Widget resources.
  returns: Widget
supported operation: Retrieves the collection of WidgetLog resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WidgetLog resources.
  returns: WidgetLog
supported operation: Retrieves the collection of TeamMember resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TeamMember resources.
  returns: TeamMember
supported operation: Retrieves the collection of Credentials resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Credentials resources.
  returns: Credentials

The collection of TeamMember resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TeamMember
supported operation: Retrieves the collection of TeamMember resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TeamMember resources.
  returns: Collection

The collection of WorkspaceMember resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: WorkspaceMember
supported operation: Retrieves the collection of WorkspaceMember resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WorkspaceMember resources.
  returns: Collection

The collection of UserSignupRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: UserSignupRequest
supported operation: Creates a UserSignupRequest resource.
  type: Operation
  type: CreateAction
  expects: UserSignupRequest
  method: POST
  title: Creates a UserSignupRequest resource.
  returns: UserSignupRequest

The collection of UserVerifyEmailRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: UserVerifyEmailRequest
supported operation: Creates a UserVerifyEmailRequest resource.
  type: Operation
  type: CreateAction
  expects: UserVerifyEmailRequest
  method: POST
  title: Creates a UserVerifyEmailRequest resource.
  returns: UserVerifyEmailRequest

The collection of UserResendEmailRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: UserResendEmailRequest
supported operation: Creates a UserResendEmailRequest resource.
  type: Operation
  type: CreateAction
  expects: UserResendEmailRequest
  method: POST
  title: Creates a UserResendEmailRequest resource.
  returns: UserResendEmailRequest

The collection of ForgotPasswordSendEmailRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ForgotPasswordSendEmailRequest
supported operation: Creates a ForgotPasswordSendEmailRequest resource.
  type: Operation
  type: CreateAction
  expects: ForgotPasswordSendEmailRequest
  method: POST
  title: Creates a ForgotPasswordSendEmailRequest resource.
  returns: ForgotPasswordSendEmailRequest

The collection of ApplyWorkspacePermissionsBatchRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ApplyWorkspacePermissionsBatchRequest
supported operation: Creates a ApplyWorkspacePermissionsBatchRequest resource.
  type: Operation
  type: CreateAction
  expects: ApplyWorkspacePermissionsBatchRequest
  method: POST
  title: Creates a ApplyWorkspacePermissionsBatchRequest resource.
  returns: ApplyWorkspacePermissionsBatchRequest

The collection of GenerateTrackingPageLinkRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: GenerateTrackingPageLinkRequest
supported operation: Creates a GenerateTrackingPageLinkRequest resource.
  type: Operation
  type: CreateAction
  expects: GenerateTrackingPageLinkRequest
  method: POST
  title: Creates a GenerateTrackingPageLinkRequest resource.
  returns: GenerateTrackingPageLinkRequest

The collection of GenerateTrackingPageLinksRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: GenerateTrackingPageLinksRequest
supported operation: Creates a GenerateTrackingPageLinksRequest resource.
  type: Operation
  type: CreateAction
  expects: GenerateTrackingPageLinksRequest
  method: POST
  title: Creates a GenerateTrackingPageLinksRequest resource.
  returns: GenerateTrackingPageLinksRequest

The collection of GenerateThemeRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: GenerateThemeRequest
supported operation: Creates a GenerateThemeRequest resource.
  type: Operation
  type: CreateAction
  expects: GenerateThemeRequest
  method: POST
  title: Creates a GenerateThemeRequest resource.
  returns: Nothing

The collection of CheckTrackingStatusesRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CheckTrackingStatusesRequest
supported operation: Creates a CheckTrackingStatusesRequest resource.
  type: Operation
  type: CreateAction
  expects: CheckTrackingStatusesRequest
  method: POST
  title: Creates a CheckTrackingStatusesRequest resource.
  returns: CheckTrackingStatusesRequest

The collection of CheckTrackingStatusesAsyncRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CheckTrackingStatusesAsyncRequest
supported operation: Creates a CheckTrackingStatusesAsyncRequest resource.
  type: Operation
  type: CreateAction
  expects: CheckTrackingStatusesAsyncRequest
  method: POST
  title: Creates a CheckTrackingStatusesAsyncRequest resource.
  returns: Nothing

The collection of PostReviewRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: PostReviewRequest
supported operation: Creates a PostReviewRequest resource.
  type: Operation
  type: CreateAction
  expects: PostReviewRequest
  method: POST
  title: Creates a PostReviewRequest resource.
  returns: PostReviewRequest

The collection of HandleChargebeeWebhookRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: HandleChargebeeWebhookRequest
supported operation: Creates a HandleChargebeeWebhookRequest resource.
  type: Operation
  type: CreateAction
  expects: HandleChargebeeWebhookRequest
  method: POST
  title: Creates a HandleChargebeeWebhookRequest resource.
  returns: Nothing

The collection of CreateChargebeeSessionRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CreateChargebeeSessionRequest
supported operation: Creates a CreateChargebeeSessionRequest resource.
  type: Operation
  type: CreateAction
  expects: CreateChargebeeSessionRequest
  method: POST
  title: Creates a CreateChargebeeSessionRequest resource.
  returns: CreateChargebeeSessionRequest

The collection of CreateChargebeeHostedPageCheckoutRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CreateChargebeeHostedPageCheckoutRequest
supported operation: Creates a CreateChargebeeHostedPageCheckoutRequest resource.
  type: Operation
  type: CreateAction
  expects: CreateChargebeeHostedPageCheckoutRequest
  method: POST
  title: Creates a CreateChargebeeHostedPageCheckoutRequest resource.
  returns: CreateChargebeeHostedPageCheckoutRequest

The collection of GetChargebeeSubscriptionEstimateRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: GetChargebeeSubscriptionEstimateRequest
supported operation: Creates a GetChargebeeSubscriptionEstimateRequest resource.
  type: Operation
  type: CreateAction
  expects: GetChargebeeSubscriptionEstimateRequest
  method: POST
  title: Creates a GetChargebeeSubscriptionEstimateRequest resource.
  returns: GetChargebeeSubscriptionEstimateRequest

The collection of DowngradeChargebeeSubscriptionRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: DowngradeChargebeeSubscriptionRequest
supported operation: Creates a DowngradeChargebeeSubscriptionRequest resource.
  type: Operation
  type: CreateAction
  expects: DowngradeChargebeeSubscriptionRequest
  method: POST
  title: Creates a DowngradeChargebeeSubscriptionRequest resource.
  returns: Nothing

The collection of CheckoutShopifySubscriptionRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CheckoutShopifySubscriptionRequest
supported operation: Creates a CheckoutShopifySubscriptionRequest resource.
  type: Operation
  type: CreateAction
  expects: CheckoutShopifySubscriptionRequest
  method: POST
  title: Creates a CheckoutShopifySubscriptionRequest resource.
  returns: CheckoutShopifySubscriptionRequest

The collection of VerifyDomainRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: VerifyDomainRequest
supported operation: Creates a VerifyDomainRequest resource.
  type: Operation
  type: CreateAction
  expects: VerifyDomainRequest
  method: POST
  title: Creates a VerifyDomainRequest resource.
  returns: VerifyDomainRequest

The collection of VerifyProductsFeedRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: VerifyProductsFeedRequest
supported operation: Creates a VerifyProductsFeedRequest resource.
  type: Operation
  type: CreateAction
  expects: VerifyProductsFeedRequest
  method: POST
  title: Creates a VerifyProductsFeedRequest resource.
  returns: VerifyProductsFeedRequest

The collection of ImportProductsFeedRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ImportProductsFeedRequest
supported operation: Creates a ImportProductsFeedRequest resource.
  type: Operation
  type: CreateAction
  expects: ImportProductsFeedRequest
  method: POST
  title: Creates a ImportProductsFeedRequest resource.
  returns: ImportProductsFeedRequest

The collection of LoadDatabaseFixturesRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: LoadDatabaseFixturesRequest
supported operation: Creates a LoadDatabaseFixturesRequest resource.
  type: Operation
  type: CreateAction
  expects: LoadDatabaseFixturesRequest
  method: POST
  title: Creates a LoadDatabaseFixturesRequest resource.
  returns: LoadDatabaseFixturesRequest

The collection of SubdomainCheckRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SubdomainCheckRequest
supported operation: Creates a SubdomainCheckRequest resource.
  type: Operation
  type: CreateAction
  expects: SubdomainCheckRequest
  method: POST
  title: Creates a SubdomainCheckRequest resource.
  returns: SubdomainCheckRequest

The collection of ShopifyRegisterRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ShopifyRegisterRequest
supported operation: Creates a ShopifyRegisterRequest resource.
  type: Operation
  type: CreateAction
  expects: ShopifyRegisterRequest
  method: POST
  title: Creates a ShopifyRegisterRequest resource.
  returns: ShopifyRegisterRequest

The collection of ShopifyWorkspaceRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ShopifyWorkspaceRequest
supported operation: Creates a ShopifyWorkspaceRequest resource.
  type: Operation
  type: CreateAction
  expects: ShopifyWorkspaceRequest
  method: POST
  title: Creates a ShopifyWorkspaceRequest resource.
  returns: ShopifyWorkspaceRequest

The collection of KlaviyoWorkspaceRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: KlaviyoWorkspaceRequest
supported operation: Creates a KlaviyoWorkspaceRequest resource.
  type: Operation
  type: CreateAction
  expects: KlaviyoWorkspaceRequest
  method: POST
  title: Creates a KlaviyoWorkspaceRequest resource.
  returns: KlaviyoWorkspaceRequest

The collection of Workspace resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Workspace
supported operation: Retrieves the collection of Workspace resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Workspace resources.
  returns: Collection
supported operation: Creates a Workspace resource.
  type: Operation
  type: CreateAction
  expects: Workspace
  method: POST
  title: Creates a Workspace resource.
  returns: Workspace
supported operation: Retrieves the collection of Shipment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Shipment resources.
  returns: Shipment
supported operation: Retrieves the collection of TrackingCheckpoint resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TrackingCheckpoint resources.
  returns: TrackingCheckpoint
supported operation: Retrieves the collection of ShipmentItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShipmentItem resources.
  returns: ShipmentItem
supported operation: Retrieves the collection of Order resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Order resources.
  returns: Order
supported operation: Retrieves the collection of OrderItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrderItem resources.
  returns: OrderItem
supported operation: Retrieves the collection of ShipmentItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShipmentItem resources.
  returns: ShipmentItem
supported operation: Retrieves the collection of Status resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Status resources.
  returns: Status
supported operation: Retrieves the collection of TrackingPage resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TrackingPage resources.
  returns: TrackingPage
supported operation: Retrieves the collection of EmailNotification resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EmailNotification resources.
  returns: EmailNotification
supported operation: Retrieves the collection of Note resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Note resources.
  returns: Note
supported operation: Retrieves the collection of Media resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Media resources.
  returns: Media
supported operation: Retrieves the collection of NoteReminder resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of NoteReminder resources.
  returns: NoteReminder
supported operation: Retrieves the collection of Workflow resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Workflow resources.
  returns: Workflow
supported operation: Retrieves the collection of WorkflowRun resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WorkflowRun resources.
  returns: WorkflowRun
supported operation: Retrieves the collection of Widget resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Widget resources.
  returns: Widget
supported operation: Retrieves the collection of WidgetLog resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WidgetLog resources.
  returns: WidgetLog

The collection of Credentials resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Credentials
supported operation: Retrieves the collection of Credentials resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Credentials resources.
  returns: Collection
supported operation: Creates a Credentials resource.
  type: Operation
  type: CreateAction
  expects: Credentials
  method: POST
  title: Creates a Credentials resource.
  returns: Credentials

The collection of Workflow resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Workflow
supported operation: Creates a Workflow resource.
  type: Operation
  type: CreateAction
  expects: Workflow
  method: POST
  title: Creates a Workflow resource.
  returns: Workflow
supported operation: Creates a Workflow resource.
  type: Operation
  type: CreateAction
  expects: Workflow
  method: POST
  title: Creates a Workflow resource.
  returns: Workflow
supported operation: Retrieves the collection of Workflow resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Workflow resources.
  returns: Collection
supported operation: Creates a Workflow resource.
  type: Operation
  type: CreateAction
  expects: Workflow
  method: POST
  title: Creates a Workflow resource.
  returns: Workflow
supported operation: Retrieves the collection of WorkflowRun resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WorkflowRun resources.
  returns: WorkflowRun

The collection of WorkflowRun resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: WorkflowRun
supported operation: Retrieves the collection of WorkflowRun resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WorkflowRun resources.
  returns: Collection

The collection of Shipment resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Shipment
supported operation: Retrieves the collection of Shipment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Shipment resources.
  returns: Collection
supported operation: Creates a Shipment resource.
  type: Operation
  type: CreateAction
  expects: Shipment
  method: POST
  title: Creates a Shipment resource.
  returns: Shipment
supported operation: Creates a Shipment resource.
  type: Operation
  type: CreateAction
  expects: Shipment
  method: POST
  title: Creates a Shipment resource.
  returns: Shipment
supported operation: Creates a Shipment resource.
  type: Operation
  type: CreateAction
  expects: Shipment
  method: POST
  title: Creates a Shipment resource.
  returns: Shipment
supported operation: Retrieves the collection of TrackingCheckpoint resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TrackingCheckpoint resources.
  returns: TrackingCheckpoint
supported operation: Retrieves the collection of ShipmentItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShipmentItem resources.
  returns: ShipmentItem

The collection of TrackingCheckpoint resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TrackingCheckpoint
supported operation: Retrieves the collection of TrackingCheckpoint resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TrackingCheckpoint resources.
  returns: Collection

The collection of OauthClient resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: OauthClient
supported operation: Retrieves the collection of OauthClient resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OauthClient resources.
  returns: Collection
supported operation: Creates a OauthClient resource.
  type: Operation
  type: CreateAction
  expects: OauthClient
  method: POST
  title: Creates a OauthClient resource.
  returns: OauthClient

The collection of Media resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Media
supported operation: Retrieves the collection of Media resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Media resources.
  returns: Collection
supported operation: Creates a Media resource.
  type: Operation
  type: CreateAction
  expects: Media
  method: POST
  title: Creates a Media resource.
  returns: Media

The collection of Import resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Import
supported operation: Creates a Import resource.
  type: Operation
  type: CreateAction
  expects: Import
  method: POST
  title: Creates a Import resource.
  returns: Import
supported operation: Creates a Import resource.
  type: Operation
  type: CreateAction
  expects: Import
  method: POST
  title: Creates a Import resource.
  returns: Import

The collection of TrackingPage resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TrackingPage
supported operation: Retrieves the collection of TrackingPage resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TrackingPage resources.
  returns: Collection
supported operation: Creates a TrackingPage resource.
  type: Operation
  type: CreateAction
  expects: TrackingPage
  method: POST
  title: Creates a TrackingPage resource.
  returns: TrackingPage

The collection of Field resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Field
supported operation: Retrieves the collection of Field resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Field resources.
  returns: Collection
supported operation: Creates a Field resource.
  type: Operation
  type: CreateAction
  expects: Field
  method: POST
  title: Creates a Field resource.
  returns: Field

The collection of EmailNotification resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: EmailNotification
supported operation: Retrieves the collection of EmailNotification resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EmailNotification resources.
  returns: Collection
supported operation: Creates a EmailNotification resource.
  type: Operation
  type: CreateAction
  expects: EmailNotification
  method: POST
  title: Creates a EmailNotification resource.
  returns: EmailNotification
supported operation: Creates a EmailNotification resource.
  type: Operation
  type: CreateAction
  expects: EmailNotification
  method: POST
  title: Creates a EmailNotification resource.
  returns: EmailNotification
supported operation: Creates a EmailNotification resource.
  type: Operation
  type: CreateAction
  expects: EmailNotification
  method: POST
  title: Creates a EmailNotification resource.
  returns: EmailNotification
supported operation: Creates a EmailNotification resource.
  type: Operation
  type: CreateAction
  expects: EmailNotification
  method: POST
  title: Creates a EmailNotification resource.
  returns: EmailNotification

The collection of FieldsLayout resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FieldsLayout
supported operation: Retrieves the collection of FieldsLayout resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FieldsLayout resources.
  returns: Collection
supported operation: Creates a FieldsLayout resource.
  type: Operation
  type: CreateAction
  expects: FieldsLayout
  method: POST
  title: Creates a FieldsLayout resource.
  returns: FieldsLayout

The collection of Carrier resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Carrier
supported operation: Retrieves the collection of Carrier resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Carrier resources.
  returns: Collection

The collection of TrackingStatus resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TrackingStatus
supported operation: Retrieves the collection of TrackingStatus resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of TrackingStatus resources.
  returns: Collection

The collection of Timezone resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Timezone
supported operation: Retrieves the collection of Timezone resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Timezone resources.
  returns: Collection

The collection of Country resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Country
supported operation: Retrieves the collection of Country resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Country resources.
  returns: Collection
supported operation: Retrieves the collection of State resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of State resources.
  returns: State

The collection of State resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: State
supported operation: Retrieves the collection of State resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of State resources.
  returns: Collection

The collection of EntityType resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: EntityType
supported operation: Retrieves the collection of EntityType resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EntityType resources.
  returns: Collection
supported operation: Creates a EntityType resource.
  type: Operation
  type: CreateAction
  expects: EntityType
  method: POST
  title: Creates a EntityType resource.
  returns: EntityType
supported operation: Creates a EntityType resource.
  type: Operation
  type: CreateAction
  expects: EntityType
  method: POST
  title: Creates a EntityType resource.
  returns: EntityType

The collection of ChangeStatusBatchAsyncRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ChangeStatusBatchAsyncRequest
supported operation: Creates a ChangeStatusBatchAsyncRequest resource.
  type: Operation
  type: CreateAction
  expects: ChangeStatusBatchAsyncRequest
  method: POST
  title: Creates a ChangeStatusBatchAsyncRequest resource.
  returns: Nothing

The collection of Notification resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Notification
supported operation: Retrieves the collection of Notification resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Notification resources.
  returns: Collection

The collection of Order resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Order
supported operation: Retrieves the collection of Order resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Order resources.
  returns: Collection
supported operation: Creates a Order resource.
  type: Operation
  type: CreateAction
  expects: Order
  method: POST
  title: Creates a Order resource.
  returns: Order
supported operation: Creates a Order resource.
  type: Operation
  type: CreateAction
  expects: Order
  method: POST
  title: Creates a Order resource.
  returns: Order
supported operation: Retrieves the collection of OrderItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrderItem resources.
  returns: OrderItem
supported operation: Retrieves the collection of ShipmentItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShipmentItem resources.
  returns: ShipmentItem

The collection of OrderItem resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: OrderItem
supported operation: Retrieves the collection of OrderItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of OrderItem resources.
  returns: Collection
supported operation: Creates a OrderItem resource.
  type: Operation
  type: CreateAction
  expects: OrderItem
  method: POST
  title: Creates a OrderItem resource.
  returns: OrderItem
supported operation: Retrieves the collection of ShipmentItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShipmentItem resources.
  returns: ShipmentItem

The collection of ShipmentItem resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ShipmentItem
supported operation: Retrieves the collection of ShipmentItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ShipmentItem resources.
  returns: Collection
supported operation: Creates a ShipmentItem resource.
  type: Operation
  type: CreateAction
  expects: ShipmentItem
  method: POST
  title: Creates a ShipmentItem resource.
  returns: ShipmentItem

The collection of Status resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Status
supported operation: Retrieves the collection of Status resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Status resources.
  returns: Collection
supported operation: Creates a Status resource.
  type: Operation
  type: CreateAction
  expects: Status
  method: POST
  title: Creates a Status resource.
  returns: Status
supported operation: Creates a Status resource.
  type: Operation
  type: CreateAction
  expects: Status
  method: POST
  title: Creates a Status resource.
  returns: Status
supported operation: Creates a Status resource.
  type: Operation
  type: CreateAction
  expects: Status
  method: POST
  title: Creates a Status resource.
  returns: Status

The collection of Note resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Note
supported operation: Retrieves the collection of Note resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Note resources.
  returns: Collection
supported operation: Creates a Note resource.
  type: Operation
  type: CreateAction
  expects: Note
  method: POST
  title: Creates a Note resource.
  returns: Note
supported operation: Retrieves the collection of Media resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Media resources.
  returns: Media
supported operation: Retrieves the collection of NoteReminder resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of NoteReminder resources.
  returns: NoteReminder

The collection of NoteReminder resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: NoteReminder
supported operation: Retrieves the collection of NoteReminder resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of NoteReminder resources.
  returns: Collection

The collection of Product resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Product
supported operation: Retrieves the collection of Product resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Product resources.
  returns: Collection
supported operation: Creates a Product resource.
  type: Operation
  type: CreateAction
  expects: Product
  method: POST
  title: Creates a Product resource.
  returns: Product
supported operation: Retrieves the collection of ProductVariant resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductVariant resources.
  returns: ProductVariant

The collection of ProductVariant resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProductVariant
supported operation: Retrieves the collection of ProductVariant resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ProductVariant resources.
  returns: Collection
supported operation: Creates a ProductVariant resource.
  type: Operation
  type: CreateAction
  expects: ProductVariant
  method: POST
  title: Creates a ProductVariant resource.
  returns: ProductVariant

The collection of LookupInvitationTeamNameRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: LookupInvitationTeamNameRequest
supported operation: Creates a LookupInvitationTeamNameRequest resource.
  type: Operation
  type: CreateAction
  expects: LookupInvitationTeamNameRequest
  method: POST
  title: Creates a LookupInvitationTeamNameRequest resource.
  returns: LookupInvitationTeamNameRequest

The collection of Widget resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Widget
supported operation: Retrieves the collection of Widget resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Widget resources.
  returns: Collection
supported operation: Creates a Widget resource.
  type: Operation
  type: CreateAction
  expects: Widget
  method: POST
  title: Creates a Widget resource.
  returns: Widget
supported operation: Retrieves the collection of WidgetLog resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WidgetLog resources.
  returns: WidgetLog

The collection of WidgetLog resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: WidgetLog
supported operation: Retrieves the collection of WidgetLog resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WidgetLog resources.
  returns: Collection

The collection of ExportEntityRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ExportEntityRequest
supported operation: Creates a ExportEntityRequest resource.
  type: Operation
  type: CreateAction
  expects: ExportEntityRequest
  method: POST
  title: Creates a ExportEntityRequest resource.
  returns: ExportEntityRequest

The collection of MarkNotificationsAsReadRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: MarkNotificationsAsReadRequest
supported operation: Creates a MarkNotificationsAsReadRequest resource.
  type: Operation
  type: CreateAction
  expects: MarkNotificationsAsReadRequest
  method: POST
  title: Creates a MarkNotificationsAsReadRequest resource.
  returns: MarkNotificationsAsReadRequest

The collection of SubscribeTeamOnTrialRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SubscribeTeamOnTrialRequest
supported operation: Creates a SubscribeTeamOnTrialRequest resource.
  type: Operation
  type: CreateAction
  expects: SubscribeTeamOnTrialRequest
  method: POST
  title: Creates a SubscribeTeamOnTrialRequest resource.
  returns: Nothing

ConstraintViolation
type: Class
title: A constraint violation
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string

ConstraintViolationList
type: Class
subclass of: Error
title: A constraint violation list
supported property: SupportedProperty
  property: violations
  title: violations
  description: The violations
  readable: true
  writeable: false

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation

Retrieves the collection of WidgetLog resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of WidgetLog resources.
returns: WidgetLog

Replaces the Shipment resource.
type: Operation
type: ReplaceAction
expects: Shipment
method: PUT
title: Replaces the Shipment resource.
returns: Shipment

Retrieves the collection of TrackingCheckpoint resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of TrackingCheckpoint resources.
returns: TrackingCheckpoint

Retrieves the collection of ShipmentItem resources.
type: Operation
type: FindAction
method: GET
title: Retrieves the collection of ShipmentItem resources.
returns: ShipmentItem

SupportedProperty
property: The collection of EmailNotification resources
title: The collection of EmailNotification resources
readable: true
writeable: false

SupportedProperty
property: The collection of FieldsLayout resources
title: The collection of FieldsLayout resources
readable: true
writeable: false

SupportedProperty
property: The collection of Carrier resources
title: The collection of Carrier resources
readable: true
writeable: false

SupportedProperty
property: The collection of TrackingStatus resources
title: The collection of TrackingStatus resources
readable: true
writeable: false

SupportedProperty
property: The collection of Timezone resources
title: The collection of Timezone resources
readable: true
writeable: false

SupportedProperty
property: The collection of Country resources
title: The collection of Country resources
readable: true
writeable: false

SupportedProperty
property: The collection of State resources
title: The collection of State resources
readable: true
writeable: false

SupportedProperty
property: The collection of EntityType resources
title: The collection of EntityType resources
readable: true
writeable: false

SupportedProperty
property: The collection of ChangeStatusBatchAsyncRequest resources
title: The collection of ChangeStatusBatchAsyncRequest resources
readable: true
writeable: false

SupportedProperty
property: The collection of Notification resources
title: The collection of Notification resources
readable: true
writeable: false

SupportedProperty
property: The collection of Order resources
title: The collection of Order resources
readable: true
writeable: false

SupportedProperty
property: The collection of OrderItem resources
title: The collection of OrderItem resources
readable: true
writeable: false

SupportedProperty
property: The collection of ShipmentItem resources
title: The collection of ShipmentItem resources
readable: true
writeable: false

SupportedProperty
property: The collection of Status resources
title: The collection of Status resources
readable: true
writeable: false

SupportedProperty
property: The collection of Note resources
title: The collection of Note resources
readable: true
writeable: false

SupportedProperty
property: The collection of NoteReminder resources
title: The collection of NoteReminder resources
readable: true
writeable: false

SupportedProperty
property: The collection of Product resources
title: The collection of Product resources
readable: true
writeable: false

SupportedProperty
property: The collection of ProductVariant resources
title: The collection of ProductVariant resources
readable: true
writeable: false

SupportedProperty
property: The collection of LookupInvitationTeamNameRequest resources
title: The collection of LookupInvitationTeamNameRequest resources
readable: true
writeable: false

SupportedProperty
property: The collection of Widget resources
title: The collection of Widget resources
readable: true
writeable: false

SupportedProperty
property: The collection of WidgetLog resources
title: The collection of WidgetLog resources
readable: true
writeable: false

SupportedProperty
property: The collection of ExportEntityRequest resources
title: The collection of ExportEntityRequest resources
readable: true
writeable: false

SupportedProperty
property: The collection of MarkNotificationsAsReadRequest resources
title: The collection of MarkNotificationsAsReadRequest resources
readable: true
writeable: false

SupportedProperty
property: The collection of SubscribeTeamOnTrialRequest resources
title: The collection of SubscribeTeamOnTrialRequest resources
readable: true
writeable: false

The API entrypoint.
type: Operation
method: GET
returns: EntryPoint