Customer API Documentation

API Endpoint

パブリックなリソースを提供します。

基本仕様は以下に従っています。

プロジェクトごとに最大20 RPS(1秒あたりのリクエスト)が適用されます。
取引内操作に関してはさらに取引ごと(取引IDごと)に最大10 RPSが適用されます。
クォータを超過するとステータスコード429を返却します。

取引内操作に関しては、取引ごと(取引IDごと)に最大1の同時実行数が適用されます。
クォータを超過するとステータスコード409を返却します。

status code	description
200 OK	リクエスト成功
400 BAD_REQUEST	リクエストに問題があります。リクエストパラメータやJSONのフォーマットを確認してください。
401 UNAUTHORIZED	Authorizationヘッダを正しく送信していることを確認してください。
403 FORBIDDEN	APIの利用権限がありません。スコープを確認してください。
404 NOT_FOUND	指定したリソースが見つかりません。
409 CONFLICT	指定したリソースにおいて競合が発生しました。
429 TOO_MANY_REQUESTS	レート制限(リクエストクォータを参照)を超過しました。時間をおいて再度アクセスしてください。
500 INTERNAL_SERVER_ERROR	APIサーバ側の一時的なエラーです。
503 SERVICE_UNAVAILABLE	APIサーバ側の一時的なエラーです。

Error response

エラー時のresponse bodyは、以下のフィールドを持つJSONデータです。

field	type	description
error	Object	エラーオブジェクト
error.code	Array	HTTPステータスコード
error.errors	Array	詳細エラーリスト
error.message	Array	エラーメッセージ
error.errors[].message	Object	詳細なエラー内容
error.errors[].name	String	エラー名称
error.errors[].reason	String	エラーの概要

OAuth ¶

アクセストークン ¶

POST https://example.com/xxxx/oauth2/token

Requestsクライアント認証

Headers

Content-Type: application/x-www-form-urlencoded
Authorization: Basic ABC123

Body

{
  "grant_type": "client_credencials",
  "state": "state123456789"
}

Schema

{
  "type": "object",
  "properties": {
    "grant_type": {
      "type": "string",
      "description": "認証タイプ(固定値)"
    },
    "state": {
      "type": "string",
      "description": "クライアント状態(クライアント側で現在のユーザー状態を表す文字列を送信してください。例えばセッションIDなどです)"
    }
  },
  "required": [
    "grant_type",
    "state"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Responses200400

Headers

Content-Type: application/json

Body

{
  "access_token": "JWT",
  "token_type": "Bearer",
  "expires_in": 1800
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "access_token": {
      "type": "string",
      "description": "アクセストークン"
    },
    "token_type": {
      "type": "string",
      "description": "発行されたトークンタイプ"
    },
    "expires_in": {
      "type": "number",
      "description": "アクセストークンの有効期間"
    }
  },
  "required": [
    "access_token",
    "token_type",
    "expires_in"
  ]
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

アクセストークン発行
POST`/oauth2/token`

OAuth2 に準拠したトークンエンドポイントです。

エンドポイントは、

https://auth.example.com/oauth2/token

となります。

開発前に、運営側よりエンドポイント、認証情報を取得してください。

利用可能な認可タイプ

client_credentials

返却値には、access_tokenとexpires_inが含まれます。

アプリケーション側でアクセストークンの有効期間を管理し、適宜再取得してください。

区分 ¶

区分検索 ¶

GET https://example.com/xxxx/categoryCode/search?page=1&limit=10&categorySetIdentifier=ContentRatingType&sellerId=xxx

Responses200400

Headers

Content-Type: application/json

Body

[
  {
    "codeValue": "xxx",
    "name": {
      "ja": "xxx",
      "en": "xxx"
    },
    "image": "xxx",
    "additionalProperty": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ]
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "codeValue": {
        "type": "string",
        "description": "コード"
      },
      "name": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "名称（日本語）"
          },
          "en": {
            "type": "string",
            "description": "名称（英語）"
          }
        }
      },
      "image": {
        "type": "string",
        "description": "イメージ"
      },
      "additionalProperty": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "プロパティ名"
            },
            "value": {
              "type": "string",
              "description": "プロパティ値"
            }
          },
          "required": [
            "name",
            "value"
          ]
        },
        "description": "追加特性"
      }
    },
    "required": [
      "codeValue"
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

区分検索
GET`/categoryCode/search{?page,limit,categorySetIdentifier,sellerId}`

区分識別子

type	description
ContentRatingType	レイティング区分
VideoFormatType	上映方式区分
DistributorType	配給区分

URI Parameters

HideShow

page: number (optional) Default: `1 Example: 1
ページ
limit: number (optional) Default: `100 Example: 10
最大取得件数
categorySetIdentifier: string (required) Example: ContentRatingType
区分識別子
sellerId: string (required) Example: xxx
販売者id

コンテンツ ¶

コンテンツ検索 ¶

GET https://example.com/xxxx/creativeWork/searchMovies?page=1&limit=10&identifiers=xxx,xxx&sellerId=xxx

Responses200400

Headers

Content-Type: application/json

Body

[
  {
    "id": "xxx",
    "identifier": "xxx",
    "name": {
      "ja": "xxx",
      "en": "xxx"
    },
    "contentRating": "xxx",
    "datePublished": "xxx",
    "duration": "PT15M",
    "thumbnailUrl": "xxx",
    "additionalProperty": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ]
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "コンテンツid"
      },
      "identifier": {
        "type": "string",
        "description": "コンテンツコード"
      },
      "name": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "コンテンツ名称（日本語）"
          },
          "en": {
            "type": "string",
            "description": "コンテンツ名称（英語）"
          }
        },
        "required": [
          "ja",
          "en"
        ]
      },
      "contentRating": {
        "type": "string",
        "description": "レイティング区分コード"
      },
      "datePublished": {
        "type": "string",
        "description": "公開日 ISO 8601 date format"
      },
      "duration": {
        "type": "string",
        "description": "上映時間 (https://en.wikipedia.org/wiki/ISO_8601#Durations)"
      },
      "thumbnailUrl": {
        "type": "string",
        "description": "サムネイルURL"
      },
      "additionalProperty": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "プロパティ名"
            },
            "value": {
              "type": "string",
              "description": "プロパティ値"
            }
          },
          "required": [
            "name",
            "value"
          ]
        },
        "description": "追加特性"
      }
    },
    "required": [
      "contentRating",
      "datePublished",
      "duration",
      "thumbnailUrl"
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

コンテンツ検索
GET`/creativeWork/searchMovies{?page,limit,identifiers,sellerId}`

URI Parameters

HideShow

page: number (optional) Default: `1 Example: 1
ページ
limit: number (optional) Default: `100 Example: 10
最大取得件数
identifiers: string (optional) Example: xxx,xxx
コンテンツコード 10件まで
sellerId: string (required) Example: xxx
販売者id

配送 ¶

同期的に注文配送 ¶

POST https://example.com/xxxx/deliver/sendOrder

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "object": {
    "orderNumber": "xxx",
    "confirmationNumber": "xxx"
  },
  "seller": {
    "id": "xxx"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "object": {
      "type": "object",
      "properties": {
        "orderNumber": {
          "type": "string",
          "description": "注文番号"
        },
        "confirmationNumber": {
          "type": "string",
          "description": "確認番号"
        }
      },
      "required": [
        "orderNumber",
        "confirmationNumber"
      ]
    },
    "seller": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "販売者id"
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

Responses200400

Headers

Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

同期的に注文配送
POST`/deliver/sendOrder`

作成された注文データに対して、同期的に注文を配送します(所有権が作成されます) すでに配送済の場合、何もしません。

イベント ¶

イベント検索 ¶

GET https://example.com/xxxx/event/screeningEvent/search?page=1&limit=10&startFrom=2023-01-01T00:00:00.000Z&startThrough=2023-01-01T00:00:00.000Z&superEventLocationBranchCodes=xxx&clientId=xxx&ids=xxx,xxx&sellerId=xxx

Responses200400

Headers

Content-Type: application/json

Body

[
  {
    "id": "xxx",
    "name": {
      "ja": "xxx",
      "en": "xxx"
    },
    "startDate": "2023-01-01T00:00:00.000Z",
    "endDate": "2023-01-01T00:00:00.000Z",
    "doorTime": "2023-01-01T00:00:00.000Z",
    "maximumAttendeeCapacity": 10,
    "remainingAttendeeCapacity": 10,
    "offers": {
      "validFrom": "2023-01-01T00:00:00.000Z",
      "validThrough": "2023-01-01T00:00:00.000Z",
      "availabilityStarts": "2023-01-01T00:00:00.000Z",
      "availabilityEnds": "2023-01-01T00:00:00.000Z",
      "itemOffered": {
        "id": "xxx"
      },
      "eligibleQuantity": {
        "maxValue": 1,
        "unitCode": "C62"
      }
    },
    "location": {
      "name": {
        "ja": "xxx",
        "en": "xxx"
      },
      "branchCode": "xxx"
    },
    "superEvent": {
      "id": "xxx",
      "name": {
        "ja": "xxx",
        "en": "xxx"
      },
      "headline": {
        "ja": "xxx",
        "en": "xxx"
      },
      "description": {
        "ja": "xxx",
        "en": "xxx"
      },
      "location": {
        "name": {
          "ja": "xxx",
          "en": "xxx"
        },
        "branchCode": "xxx"
      },
      "workPerformed": {
        "id": "xxx",
        "identifier": "xxx"
      }
    },
    "additionalProperty": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ]
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "イベント id"
      },
      "name": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "イベント名称（日本語）"
          },
          "en": {
            "type": "string",
            "description": "イベント名称（英語）"
          }
        }
      },
      "startDate": {
        "type": "string",
        "description": "開始日時 ISO 8601 date format"
      },
      "endDate": {
        "type": "string",
        "description": "終了日時 ISO 8601 date format"
      },
      "doorTime": {
        "type": "string",
        "description": "開場日時 ISO 8601 date format"
      },
      "maximumAttendeeCapacity": {
        "type": "number",
        "description": "最大収容人数"
      },
      "remainingAttendeeCapacity": {
        "type": "number",
        "description": "残り収容人数"
      },
      "offers": {
        "type": "object",
        "properties": {
          "validFrom": {
            "type": "string",
            "description": "販売開始日時 ISO 8601 date format"
          },
          "validThrough": {
            "type": "string",
            "description": "販売終了日時 ISO 8601 date format"
          },
          "availabilityStarts": {
            "type": "string",
            "description": "表示開始日時 ISO 8601 date format"
          },
          "availabilityEnds": {
            "type": "string",
            "description": "表示終了日時 ISO 8601 date format"
          },
          "itemOffered": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "興行Id"
              }
            }
          },
          "eligibleQuantity": {
            "type": "object",
            "properties": {
              "maxValue": {
                "type": "number",
                "description": "販売上限席数"
              },
              "unitCode": {
                "type": "string",
                "description": "単位"
              }
            }
          }
        },
        "description": "販売表示情報"
      },
      "location": {
        "type": "object",
        "properties": {
          "name": {
            "type": "object",
            "properties": {
              "ja": {
                "type": "string",
                "description": "ルーム名称（日本語）"
              },
              "en": {
                "type": "string",
                "description": "ルーム名称（英語）"
              }
            }
          },
          "branchCode": {
            "type": "string",
            "description": "ルームコード"
          }
        },
        "required": [
          "branchCode"
        ]
      },
      "superEvent": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "施設コンテンツ id"
          },
          "name": {
            "type": "object",
            "properties": {
              "ja": {
                "type": "string",
                "description": "施設コンテンツ名称（日本語）"
              },
              "en": {
                "type": "string",
                "description": "施設コンテンツ名称（英語）"
              }
            }
          },
          "headline": {
            "type": "object",
            "properties": {
              "ja": {
                "type": "string",
                "description": "施設コンテンツサブタイトル（日本語）"
              },
              "en": {
                "type": "string",
                "description": "施設コンテンツサブタイトル（英語）"
              }
            }
          },
          "description": {
            "type": "object",
            "properties": {
              "ja": {
                "type": "string",
                "description": "施設コンテンツ補足説明（日本語）"
              },
              "en": {
                "type": "string",
                "description": "施設コンテンツ補足説明（英語）"
              }
            }
          },
          "location": {
            "type": "object",
            "properties": {
              "name": {
                "type": "object",
                "properties": {
                  "ja": {
                    "type": "string",
                    "description": "施設名称（日本語）"
                  },
                  "en": {
                    "type": "string",
                    "description": "施設名称（英語）"
                  }
                }
              },
              "branchCode": {
                "type": "string",
                "description": "施設コード"
              }
            },
            "required": [
              "branchCode"
            ]
          },
          "workPerformed": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "コンテンツ id"
              },
              "identifier": {
                "type": "string",
                "description": "コンテンツコード"
              }
            },
            "required": [
              "id",
              "identifier"
            ]
          }
        },
        "required": [
          "id"
        ]
      },
      "additionalProperty": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "プロパティ名"
            },
            "value": {
              "type": "string",
              "description": "プロパティ値"
            }
          },
          "required": [
            "name",
            "value"
          ]
        },
        "description": "追加特性"
      }
    },
    "required": [
      "id",
      "startDate",
      "endDate"
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

イベント検索
GET`/event/screeningEvent/search{?page,limit,startFrom,startThrough,superEventLocationBranchCodes,clientId,ids,sellerId}`

URI Parameters

HideShow

page: number (optional) Default: `1 Example: 1
ページ
limit: number (optional) Default: `100 Example: 10
最大取得件数
startFrom: string (optional) Example: 2023-01-01T00:00:00.000Z
開始日時範囲(から) ISO 8601 date format
startThrough: string (optional) Example: 2023-01-01T00:00:00.000Z
開始日時範囲(まで) ISO 8601 date format
superEventLocationBranchCodes: string (optional) Example: xxx
施設コード
clientId: string (optional) Example: xxx
取得したい販売表示情報のクライアント id
ids: string (optional) Example: xxx,xxx
イベントid 10件まで
sellerId: string (required) Example: xxx
販売者id

イベントオファー検索 ¶

GET https://example.com/xxxx/event/screeningEvent/searchTicketOffers?page=1&limit=10&eventId=xxx&sellerId=xxx

Responses200400

Headers

Content-Type: application/json

Body

[
  {
    "id": "xxx",
    "identifier": "xxx",
    "name": {
      "ja": "xxx",
      "en": "xxx"
    },
    "description": {
      "ja": "xxx",
      "en": "xxx"
    },
    "sortIndex": "1",
    "priceSpecification": {
      "priceComponent": [
        {
          "name": {
            "ja": "xxx",
            "en": "xxx"
          },
          "price": 1000,
          "typeOf": "UnitPriceSpecification",
          "referenceQuantity": {
            "value": 1
          },
          "appliesToMovieTicket": {
            "serviceType": "xxx",
            "serviceOutput": {
              "serviceType": "xxx"
            }
          }
        }
      ]
    },
    "eligibleSeatingType": [
      {
        "codeValue": "xxx"
      }
    ],
    "eligibleSubReservation": [
      {
        "amountOfThisGood": 1,
        "typeOfGood": {
          "seatingType": "xxx"
        }
      }
    ],
    "addOn": [
      {
        "itemOffered": {
          "id": "xxx"
        }
      }
    ],
    "additionalProperty": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ]
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "オファーid"
      },
      "identifier": {
        "type": "string",
        "description": "オファーコード"
      },
      "name": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "オファー名称（日本語）"
          },
          "en": {
            "type": "string",
            "description": "オファー名称（英語）"
          }
        }
      },
      "description": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "オファー説明（日本語）"
          },
          "en": {
            "type": "string",
            "description": "オファー説明（英語）"
          }
        }
      },
      "sortIndex": {
        "type": "string",
        "description": "オファー並び順"
      },
      "priceSpecification": {
        "type": "object",
        "properties": {
          "priceComponent": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "object",
                  "properties": {
                    "ja": {
                      "type": "string",
                      "description": "価格要素名称（日本語）"
                    },
                    "en": {
                      "type": "string",
                      "description": "価格要素名称（英語）"
                    }
                  }
                },
                "price": {
                  "type": "number",
                  "description": "価格要素価格"
                },
                "typeOf": {
                  "type": "string",
                  "enum": [
                    "UnitPriceSpecification",
                    "CategoryCodeChargeSpecification",
                    "MovieTicketTypeChargeSpecification"
                  ],
                  "description": "価格要素タイプ CategoryCodeChargeSpecification (カテゴリーコード加算仕様) or MovieTicketTypeChargeSpecification (ムビチケ加算仕様) or UnitPriceSpecification (単価仕様)"
                },
                "referenceQuantity": {
                  "type": "object",
                  "properties": {
                    "value": {
                      "type": "number",
                      "description": "価格要素基準数量"
                    }
                  }
                },
                "appliesToMovieTicket": {
                  "type": "object",
                  "properties": {
                    "serviceType": {
                      "type": "string",
                      "description": "決済カード区分コード"
                    },
                    "serviceOutput": {
                      "type": "object",
                      "properties": {
                        "serviceType": {
                          "type": "string",
                          "description": "決済方法区分コード"
                        }
                      },
                      "required": [
                        "serviceType"
                      ]
                    }
                  },
                  "required": [
                    "serviceType"
                  ]
                }
              },
              "required": [
                "price",
                "typeOf"
              ]
            }
          }
        },
        "required": [
          "priceComponent"
        ]
      },
      "eligibleSeatingType": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "codeValue": {
              "type": "string",
              "description": "座席区分"
            }
          },
          "required": [
            "codeValue"
          ]
        }
      },
      "eligibleSubReservation": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "amountOfThisGood": {
              "type": "number",
              "description": "必要座席数"
            },
            "typeOfGood": {
              "type": "object",
              "properties": {
                "seatingType": {
                  "type": "string",
                  "description": "必要座席区分"
                }
              },
              "required": [
                "seatingType"
              ]
            }
          },
          "required": [
            "amountOfThisGood"
          ]
        }
      },
      "addOn": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "itemOffered": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "アドオンオファー id"
                }
              }
            }
          }
        }
      },
      "additionalProperty": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "プロパティ名"
            },
            "value": {
              "type": "string",
              "description": "プロパティ値"
            }
          },
          "required": [
            "name",
            "value"
          ]
        },
        "description": "追加特性"
      }
    },
    "required": [
      "identifier"
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

イベントオファー検索
GET`/event/screeningEvent/searchTicketOffers{?page,limit,eventId,sellerId}`

価格要素タイプ

type	description
UnitPriceSpecification	単価仕様
CategoryCodeChargeSpecification	カテゴリーコード加算仕様
MovieTicketTypeChargeSpecification	ムビチケ加算仕様

URI Parameters

HideShow

page: number (optional) Default: `1 Example: 1
ページ
limit: number (optional) Default: `100 Example: 10
最大取得件数
eventId: string (required) Example: xxx
イベント id
sellerId: string (required) Example: xxx
販売者id

座席ステータス検索 ¶

GET https://example.com/xxxx/event/screeningEvent/searchSeats?page=1&limit=10&eventId=xxx&sellerId=xxx

Responses200400

Headers

Content-Type: application/json

Body

[
  {
    "name": {
      "ja": "xxx",
      "en": "xxx"
    },
    "branchCode": "xxx",
    "containedInPlace": {
      "branchCode": "xxx"
    },
    "seatingType": [
      "xxx"
    ],
    "offers": [
      "xxx"
    ]
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "name": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "座席名称（日本語）"
          },
          "en": {
            "type": "string",
            "description": "座席名称（英語）"
          }
        }
      },
      "branchCode": {
        "type": "string",
        "description": "座席コード"
      },
      "containedInPlace": {
        "type": "object",
        "properties": {
          "branchCode": {
            "type": "string",
            "description": "セクションコード"
          }
        }
      },
      "seatingType": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "offers": {
        "type": "array",
        "description": "商品在庫状況"
      }
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

座席ステータス検索
GET`/event/screeningEvent/searchSeats{?page,limit,eventId,sellerId}`

イベントのルームに含まれるひとつめのセクションの座席とその在庫を検索します。複数セクションのルームには対応していません。

在庫ステータス

type	description
InStock	在庫あり
OutOfStock	在庫なし

URI Parameters

HideShow

page: number (optional) Default: `1 Example: 1
ページ
limit: number (optional) Default: `100 Example: 10
最大取得件数
eventId: string (required) Example: xxx
イベント id
sellerId: string (required) Example: xxx
販売者id

施設コンテンツ検索 ¶

GET https://example.com/xxxx/event/screeningEventSeries/search?page=1&limit=10&startFrom=2023-01-01T00:00:00.000Z&startThrough=2023-01-01T00:00:00.000Z&endFrom=2023-01-01T00:00:00.000Z&endThrough=2023-01-01T00:00:00.000Z&locationBranchCode=xxx&workPerformedIdentifier=xxx&sellerId=xxx

Responses200400

Headers

Content-Type: application/json

Body

[
  {
    "id": "xxx",
    "name": {
      "ja": "xxx",
      "en": "xxx"
    },
    "startDate": "2023-01-01T00:00:00.000Z",
    "endDate": "2023-01-01T00:00:00.000Z",
    "headline": {
      "ja": "xxx",
      "en": "xxx"
    },
    "description": {
      "ja": "xxx",
      "en": "xxx"
    },
    "additionalProperty": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ],
    "kanaName": "xxx",
    "videoFormat": [
      {
        "typeOf": "xxx",
        "name": "xxx"
      }
    ],
    "subtitleLanguage": {
      "name": "Japanese"
    },
    "dubLanguage": {
      "name": "Japanese"
    }
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "id"
      },
      "name": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "名称（日本語）"
          },
          "en": {
            "type": "string",
            "description": "名称（英語）"
          }
        }
      },
      "startDate": {
        "type": "string",
        "description": "開始日時 ISO 8601 date format"
      },
      "endDate": {
        "type": "string",
        "description": "終了日時 ISO 8601 date format"
      },
      "headline": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "サブタイトル（日本語）"
          },
          "en": {
            "type": "string",
            "description": "サブタイトル（英語）"
          }
        }
      },
      "description": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "補足説明（日本語）"
          },
          "en": {
            "type": "string",
            "description": "補足説明（英語）"
          }
        }
      },
      "additionalProperty": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "プロパティ名"
            },
            "value": {
              "type": "string",
              "description": "プロパティ値"
            }
          },
          "required": [
            "name",
            "value"
          ]
        },
        "description": "追加特性"
      },
      "kanaName": {
        "type": "string",
        "description": "カナ名称"
      },
      "videoFormat": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "typeOf": {
              "type": "string",
              "description": "コード"
            },
            "name": {
              "type": "string",
              "description": "名称"
            }
          },
          "required": [
            "typeOf",
            "name"
          ]
        },
        "description": "上映方式"
      },
      "subtitleLanguage": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "字幕"
          }
        }
      },
      "dubLanguage": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "吹替"
          }
        }
      }
    },
    "required": [
      "id"
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

施設コンテンツ検索
GET`/event/screeningEventSeries/search{?page,limit,startFrom,startThrough,endFrom,endThrough,locationBranchCode,workPerformedIdentifier,sellerId}`

URI Parameters

HideShow

page: number (optional) Default: `1 Example: 1
ページ
limit: number (optional) Default: `100 Example: 10
最大取得件数
startFrom: string (optional) Example: 2023-01-01T00:00:00.000Z
開始日時範囲(から) ISO 8601 date format
startThrough: string (optional) Example: 2023-01-01T00:00:00.000Z
開始日時範囲(まで) ISO 8601 date format
endFrom: string (optional) Example: 2023-01-01T00:00:00.000Z
終了日時範囲(から) ISO 8601 date format
endThrough: string (optional) Example: 2023-01-01T00:00:00.000Z
終了日時範囲(まで) ISO 8601 date format
locationBranchCode: string (optional) Example: xxx
施設コード
workPerformedIdentifier: string (optional) Example: xxx
コンテンツコード
sellerId: string (required) Example: xxx
販売者id

注文 ¶

確認番号で注文検索 ¶

GET https://example.com/xxxx/order/findByConfirmationNumber?confirmationNumber=xxx&telephone=+819012345678

Responses200400

Headers

Content-Type: application/json

Body

[
  {
    "orderDate": "xxx",
    "confirmationNumber": "xxx",
    "orderNumber": "xxx",
    "price": 1000,
    "orderStatus": "OrderDelivered",
    "paymentMethods": [
      {
        "name": "xxx",
        "paymentMethodId": "xxx",
        "accountId": "xxx",
        "totalPaymentDue": {
          "currency": "xxx",
          "value": 1000
        },
        "paymentMethod": {
          "identifier": "xxx"
        }
      }
    ]
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "orderDate": {
        "type": "string",
        "description": "注文日時 ISO 8601 date format"
      },
      "confirmationNumber": {
        "type": "string",
        "description": "確認番号"
      },
      "orderNumber": {
        "type": "string",
        "description": "注文番号"
      },
      "price": {
        "type": "number",
        "description": "注文金額"
      },
      "orderStatus": {
        "type": "string",
        "enum": [
          "OrderDelivered",
          "OrderReturned"
        ],
        "description": "注文ステータス"
      },
      "paymentMethods": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "決済方法名称"
            },
            "paymentMethodId": {
              "type": "string",
              "description": "決済id"
            },
            "accountId": {
              "type": "string",
              "description": "アカウントid"
            },
            "totalPaymentDue": {
              "type": "object",
              "properties": {
                "currency": {
                  "type": "string",
                  "description": "通貨"
                },
                "value": {
                  "type": "number",
                  "description": "値"
                }
              }
            },
            "paymentMethod": {
              "type": "object",
              "properties": {
                "identifier": {
                  "type": "string",
                  "description": "決済方法区分コード"
                }
              }
            }
          },
          "required": [
            "name"
          ]
        },
        "description": "決済情報"
      }
    },
    "required": [
      "confirmationNumber",
      "orderNumber",
      "price"
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

確認番号で注文検索
GET`/order/findByConfirmationNumber{?confirmationNumber,telephone}`

注文ステータス

type	description
OrderDelivered	注文配送済み
OrderReturned	注文返品済み

URI Parameters

HideShow

confirmationNumber: string (required) Example: xxx
確認番号
telephone: string (required) Example: +819012345678
購入者電話番号 E.164
sellerId: string (required) Example: xxx
販売者 id

注文アイテム検索 ¶

GET https://example.com/xxxx/order/searchAcceptedOffersByConfirmationNumber?page=1&limit=10&confirmationNumber=xxx&orderNumber=xxx&sellerId=xxx

Responses200400

Headers

Content-Type: application/json

Body

[
  {
    "itemOffered": {
      "id": 0,
      "reservationNumber": 0,
      "additionalProperty": [
        {
          "name": "xxx",
          "value": "xxx"
        }
      ],
      "reservationFor": {
        "id": "xxx",
        "name": {
          "ja": "xxx",
          "en": "xxx"
        },
        "startDate": "2023-01-01T00:00:00.000Z",
        "endDate": "2023-01-01T00:00:00.000Z",
        "doorTime": "2023-01-01T00:00:00.000Z",
        "location": {
          "name": {
            "ja": "xxx",
            "en": "xxx",
            "branchCode": "xxx"
          }
        }
      },
      "reservedTicket": {
        "ticketType": {
          "identifier": "xxx",
          "name": {
            "ja": "xxx",
            "en": "xxx"
          }
        },
        "ticketedSeat": {
          "seatNumber": "xxx",
          "seatSection": "xxx",
          "seatingType": [
            "xxx"
          ]
        }
      },
      "priceSpecification": {
        "priceComponent": [
          {
            "name": {
              "ja": "xxx",
              "en": "xxx"
            },
            "price": 1000,
            "typeOf": "UnitPriceSpecification",
            "referenceQuantity": {
              "value": 1
            }
          }
        ]
      }
    }
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "itemOffered": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "予約 id"
          },
          "reservationNumber": {
            "type": "number",
            "description": "予約番号"
          },
          "additionalProperty": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "プロパティ名"
                },
                "value": {
                  "type": "string",
                  "description": "プロパティ値"
                }
              },
              "required": [
                "name",
                "value"
              ]
            },
            "description": "追加特性"
          },
          "reservationFor": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "イベントid"
              },
              "name": {
                "type": "object",
                "properties": {
                  "ja": {
                    "type": "string",
                    "description": "イベント名称（日本語）"
                  },
                  "en": {
                    "type": "string",
                    "description": "イベント名称（英語）"
                  }
                }
              },
              "startDate": {
                "type": "string",
                "description": "開始日時 ISO 8601 date format"
              },
              "endDate": {
                "type": "string",
                "description": "終了日時 ISO 8601 date format"
              },
              "doorTime": {
                "type": "string",
                "description": "開場日時 ISO 8601 date format"
              },
              "location": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "object",
                    "properties": {
                      "ja": {
                        "type": "string",
                        "description": "ルーム名称（日本語）"
                      },
                      "en": {
                        "type": "string",
                        "description": "ルーム名称（英語）"
                      },
                      "branchCode": {
                        "type": "string",
                        "description": "ルームコード"
                      }
                    },
                    "required": [
                      "branchCode"
                    ]
                  }
                }
              }
            },
            "required": [
              "id",
              "startDate",
              "endDate"
            ]
          },
          "reservedTicket": {
            "type": "object",
            "properties": {
              "ticketType": {
                "type": "object",
                "properties": {
                  "identifier": {
                    "type": "string",
                    "description": "オファーコード"
                  },
                  "name": {
                    "type": "object",
                    "properties": {
                      "ja": {
                        "type": "string",
                        "description": "オファー名称（日本語）"
                      },
                      "en": {
                        "type": "string",
                        "description": "オファー名称（英語）"
                      }
                    }
                  }
                },
                "required": [
                  "identifier"
                ]
              },
              "ticketedSeat": {
                "type": "object",
                "properties": {
                  "seatNumber": {
                    "type": "string",
                    "description": "座席コード"
                  },
                  "seatSection": {
                    "type": "string",
                    "description": "座席セクション"
                  },
                  "seatingType": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                },
                "required": [
                  "seatNumber",
                  "seatSection"
                ]
              }
            }
          },
          "priceSpecification": {
            "type": "object",
            "properties": {
              "priceComponent": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "object",
                      "properties": {
                        "ja": {
                          "type": "string",
                          "description": "価格要素名称（日本語）"
                        },
                        "en": {
                          "type": "string",
                          "description": "価格要素名称（英語）"
                        }
                      }
                    },
                    "price": {
                      "type": "number",
                      "description": "価格要素価格"
                    },
                    "typeOf": {
                      "type": "string",
                      "enum": [
                        "UnitPriceSpecification",
                        "CategoryCodeChargeSpecification",
                        "MovieTicketTypeChargeSpecification"
                      ],
                      "description": "価格要素タイプ CategoryCodeChargeSpecification (カテゴリーコード加算仕様) or MovieTicketTypeChargeSpecification (ムビチケ加算仕様) or UnitPriceSpecification (単価仕様)"
                    },
                    "referenceQuantity": {
                      "type": "object",
                      "properties": {
                        "value": {
                          "type": "number",
                          "description": "価格要素基準数量"
                        }
                      }
                    }
                  },
                  "required": [
                    "price",
                    "typeOf"
                  ]
                }
              }
            },
            "required": [
              "priceComponent"
            ]
          }
        },
        "required": [
          "id",
          "reservationNumber"
        ]
      }
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

注文アイテム検索
GET`/order/searchAcceptedOffersByConfirmationNumber{?page,limit,confirmationNumber,orderNumber,sellerId}`

価格要素タイプ

type	description
UnitPriceSpecification	単価仕様
CategoryCodeChargeSpecification	カテゴリーコード加算仕様
MovieTicketTypeChargeSpecification	ムビチケ加算仕様

URI Parameters

HideShow

page: number (optional) Default: `1 Example: 1
ページ
limit: number (optional) Default: `100 Example: 10
最大取得件数
confirmationNumber: string (required) Example: xxx
確認番号
orderNumber: string (required) Example: xxx
注文番号
sellerId: string (required) Example: xxx
販売者 id

注文コード発行 ¶

POST https://example.com/xxxx/order/authorize

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "orderNumber": "xxx",
  "expiresInSeconds": "2023-01-01T00:00:00.000Z",
  "customer": {
    "telephone": "+819012345678"
  },
  "seller": {
    "id": "xxx"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "orderNumber": {
      "type": "string",
      "description": "注文番号"
    },
    "expiresInSeconds": {
      "type": "string",
      "description": "コード期限 ISO 8601 date format"
    },
    "customer": {
      "type": "object",
      "properties": {
        "telephone": {
          "type": "string",
          "description": "購入者電話番号 E.164"
        }
      }
    },
    "seller": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "販売者 id"
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "required": [
    "orderNumber",
    "expiresInSeconds"
  ]
}

Responses200400

Headers

Content-Type: application/json

Body

{
  "code": "xxx"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "注文コード"
    }
  },
  "required": [
    "code"
  ]
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

注文コード発行
POST`/order/authorize`

同期的に注文作成 ¶

POST https://example.com/xxxx/order/placeOrder

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "object": {
    "orderNumber": "xxx",
    "confirmationNumber": "xxx"
  },
  "purpose": {
    "id": "xxx"
  },
  "seller": {
    "id": "xxx"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "object": {
      "type": "object",
      "properties": {
        "orderNumber": {
          "type": "string",
          "description": "注文番号"
        },
        "confirmationNumber": {
          "type": "string",
          "description": "確認番号"
        }
      },
      "required": [
        "orderNumber",
        "confirmationNumber"
      ]
    },
    "purpose": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "取引id"
        }
      },
      "required": [
        "id"
      ]
    },
    "seller": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "販売者id"
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

Responses200400

Headers

Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

同期的に注文作成
POST`/order/placeOrder`

確定した注文取引に対して、同期的に注文データを作成すでに注文が作成済の場合、何もしない

施設 ¶

施設検索 ¶

GET https://example.com/xxxx/place/searchMovieTheaters?page=1&limit=10&sellerId=xxx

Responses200400

Headers

Content-Type: application/json

Body

[
  {
    "id": "xxx",
    "name": {
      "ja": "xxx",
      "en": "xxx"
    },
    "branchCode": "xxx",
    "parentOrganization": {
      "id": "xxx"
    },
    "hasEntranceGate": [
      {
        "name": {
          "ja": "xxx",
          "en": "xxx"
        },
        "identifier": "xxx"
      }
    ],
    "additionalProperty": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ]
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "施設 id"
      },
      "name": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "施設名称（日本語）"
          },
          "en": {
            "type": "string",
            "description": "施設名称（英語）"
          }
        },
        "required": [
          "ja",
          "en"
        ]
      },
      "branchCode": {
        "type": "string",
        "description": "施設コード"
      },
      "parentOrganization": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "親組織 id"
          }
        },
        "required": [
          "id"
        ]
      },
      "hasEntranceGate": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "object",
              "properties": {
                "ja": {
                  "type": "string",
                  "description": "名称（日本語）"
                },
                "en": {
                  "type": "string",
                  "description": "名称（英語）"
                }
              }
            },
            "identifier": {
              "type": "string",
              "description": "コード"
            }
          },
          "required": [
            "identifier"
          ]
        },
        "description": "入場ゲート"
      },
      "additionalProperty": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "プロパティ名"
            },
            "value": {
              "type": "string",
              "description": "プロパティ値"
            }
          },
          "required": [
            "name",
            "value"
          ]
        },
        "description": "追加特性"
      }
    },
    "required": [
      "id",
      "branchCode"
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

施設検索
GET`/place/searchMovieTheaters{?page,limit,sellerId}`

URI Parameters

HideShow

page: number (optional) Default: `1 Example: 1
ページ
limit: number (optional) Default: `100 Example: 10
最大取得件数
sellerId: string (required) Example: xxx
販売者id

ルーム検索 ¶

GET https://example.com/xxxx/place/searchScreeningRooms?page=1&limit=10&sellerId=xxx

Responses200400

Headers

Content-Type: application/json

Body

[
  {
    "name": {
      "ja": "xxx",
      "en": "xxx"
    },
    "branchCode": "xxx",
    "openSeatingAllowed": true,
    "additionalProperty": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ]
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "name": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "ルーム名称（日本語）"
          },
          "en": {
            "type": "string",
            "description": "ルーム名称（英語）"
          }
        },
        "required": [
          "ja",
          "en"
        ]
      },
      "branchCode": {
        "type": "string",
        "description": "ルームコード"
      },
      "openSeatingAllowed": {
        "type": "boolean",
        "description": "自由席フラグ"
      },
      "additionalProperty": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "プロパティ名"
            },
            "value": {
              "type": "string",
              "description": "プロパティ値"
            }
          },
          "required": [
            "name",
            "value"
          ]
        },
        "description": "追加特性"
      }
    },
    "required": [
      "branchCode"
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

ルーム検索
GET`/place/searchScreeningRooms{?page,limit,sellerId}`

URI Parameters

HideShow

page: number (optional) Default: `1 Example: 1
ページ
limit: number (optional) Default: `100 Example: 10
最大取得件数
sellerId: string (required) Example: xxx
販売者id

プロダクト ¶

プロダクト検索 ¶

GET https://example.com/xxxx/product/search?page=1&limit=10&typeOf=EventService&sellerId=xxx

Responses200400

Headers

Content-Type: application/json

Body

[
  {
    "id": "xxx",
    "name": {
      "ja": "xxx",
      "en": "xxx"
    },
    "description": {
      "ja": "xxx",
      "en": "xxx"
    },
    "productID": "xxx",
    "serviceType": {
      "codeValue": "xxx",
      "inCodeSet": {
        "identifier": "xxx"
      }
    }
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "プロダクト id"
      },
      "name": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "プロダクト名称（日本語）"
          },
          "en": {
            "type": "string",
            "description": "プロダクト名称（英語）"
          }
        }
      },
      "description": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "プロダクト説明（日本語）"
          },
          "en": {
            "type": "string",
            "description": "プロダクト説明（英語）"
          }
        }
      },
      "productID": {
        "type": "string",
        "description": "プロダクトコード"
      },
      "serviceType": {
        "type": "object",
        "properties": {
          "codeValue": {
            "type": "string",
            "description": "区分コード"
          },
          "inCodeSet": {
            "type": "object",
            "properties": {
              "identifier": {
                "type": "string",
                "description": "区分分類"
              }
            }
          }
        }
      }
    },
    "required": [
      "id",
      "productID"
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

プロダクト検索
GET`/product/search{?page,limit,typeOf,sellerId}`

プロダクトタイプ

type	description
EventService	興行
Product	アドオン

URI Parameters

HideShow

page: number (optional) Default: `1 Example: 1
ページ
limit: number (optional) Default: `100 Example: 10
最大取得件数
sellerId: string (optional) Example: xxx
販売者 Id
typeOf: string (optional) Example: EventService
プロダクトタイプ

オファー検索 ¶

GET https://example.com/xxxx/product/searchOffers?page=1&limit=10&itemOfferedId=xxx&sellerId=xxx

Responses200400

Headers

Content-Type: application/json

Body

[
  {
    "id": "xxx",
    "name": {
      "ja": "xxx",
      "en": "xxx"
    },
    "description": {
      "ja": "xxx",
      "en": "xxx"
    },
    "priceSpecification": {
      "priceComponent": [
        {
          "name": {
            "ja": "xxx",
            "en": "xxx"
          },
          "price": 1000,
          "typeOf": "UnitPriceSpecification",
          "referenceQuantity": {
            "value": 1
          },
          "appliesToMovieTicket": {
            "serviceType": 1,
            "serviceOutput": {
              "serviceType": 1
            }
          }
        }
      ]
    }
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "オファー id"
      },
      "name": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "オファー名称（日本語）"
          },
          "en": {
            "type": "string",
            "description": "オファー名称（英語）"
          }
        }
      },
      "description": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "オファー説明（日本語）"
          },
          "en": {
            "type": "string",
            "description": "オファー説明（英語）"
          }
        }
      },
      "priceSpecification": {
        "type": "object",
        "properties": {
          "priceComponent": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "object",
                  "properties": {
                    "ja": {
                      "type": "string",
                      "description": "価格要素名称（日本語）"
                    },
                    "en": {
                      "type": "string",
                      "description": "価格要素名称（英語）"
                    }
                  }
                },
                "price": {
                  "type": "number",
                  "description": "価格要素価格"
                },
                "typeOf": {
                  "type": "string",
                  "enum": [
                    "UnitPriceSpecification",
                    "CategoryCodeChargeSpecification",
                    "MovieTicketTypeChargeSpecification"
                  ],
                  "description": "価格要素タイプ CategoryCodeChargeSpecification (カテゴリーコード加算仕様) or MovieTicketTypeChargeSpecification (ムビチケ加算仕様) or UnitPriceSpecification (単価仕様)"
                },
                "referenceQuantity": {
                  "type": "object",
                  "properties": {
                    "value": {
                      "type": "number",
                      "description": "価格要素基準数量"
                    }
                  }
                },
                "appliesToMovieTicket": {
                  "type": "object",
                  "properties": {
                    "serviceType": {
                      "type": "number",
                      "description": "決済カード区分コード"
                    },
                    "serviceOutput": {
                      "type": "object",
                      "properties": {
                        "serviceType": {
                          "type": "number",
                          "description": "決済方法区分コード"
                        }
                      },
                      "required": [
                        "serviceType"
                      ]
                    }
                  },
                  "required": [
                    "serviceType"
                  ]
                }
              },
              "required": [
                "price",
                "typeOf"
              ]
            }
          }
        },
        "required": [
          "priceComponent"
        ]
      }
    },
    "required": [
      "id"
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

オファー検索
GET`/product/searchOffers{?page,limit,itemOfferedId,sellerId}`

価格要素タイプ

type	description
UnitPriceSpecification	単価仕様
CategoryCodeChargeSpecification	カテゴリーコード加算仕様
MovieTicketTypeChargeSpecification	ムビチケ加算仕様

URI Parameters

HideShow

page: number (optional) Default: `1 Example: 1
ページ
limit: number (optional) Default: `100 Example: 10
最大取得件数
sellerId: string (optional) Example: xxx
販売者 Id
itemOfferedId: string (optional) Example: xxx
アイテム Id

予約 ¶

コードによる予約照会 ¶

POST https://example.com/xxxx/reservation/findByCode

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "object": {
    "id": "xxx"
  },
  "instrument": {
    "code": "xxx"
  },
  "seller": {
    "id": "xxx"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "object": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "予約id"
        }
      },
      "required": [
        "id"
      ]
    },
    "instrument": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "注文コード"
        }
      },
      "required": [
        "code"
      ]
    },
    "seller": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "販売者 id"
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "required": [
    "object",
    "instrument"
  ]
}

Responses200400

Headers

Content-Type: application/json

Body

{
  "id": "xxx",
  "reservationStatus": "ReservationConfirmed",
  "reservedTicket": {
    "ticketType": {
      "identifier": "xxx",
      "name": {
        "ja": "xxx"
      }
    }
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "予約id"
    },
    "reservationStatus": {
      "type": "string",
      "description": "予約ステータス"
    },
    "reservedTicket": {
      "type": "object",
      "properties": {
        "ticketType": {
          "type": "object",
          "properties": {
            "identifier": {
              "type": "string",
              "description": "オファーコード"
            },
            "name": {
              "type": "object",
              "properties": {
                "ja": {
                  "type": "string",
                  "description": "オファー名称（日本語）"
                }
              }
            }
          },
          "required": [
            "identifier"
          ]
        }
      },
      "required": [
        "ticketType"
      ]
    }
  },
  "required": [
    "id",
    "reservationStatus",
    "reservedTicket"
  ]
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

コードによる予約照会
POST`/reservation/findByCode`

予約ステータス

type	description
ReservationConfirmed	予約確認済み
ReservationCancelled	予約キャンセル済み

販売者 ¶

販売者検索 ¶

GET https://example.com/xxxx/seller/search?page=1&limit=10

Responses200400

Headers

Content-Type: application/json

Body

[
  {
    "id": "xxx",
    "name": {
      "ja": "xxx",
      "en": "xxx"
    },
    "branchCode": "xxx",
    "additionalProperty": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ]
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "販売者 id"
      },
      "name": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "販売者名称（日本語）"
          },
          "en": {
            "type": "string",
            "description": "販売者名称（英語）"
          }
        },
        "required": [
          "ja",
          "en"
        ]
      },
      "branchCode": {
        "type": "string",
        "description": "販売者コード"
      },
      "additionalProperty": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "プロパティ名"
            },
            "value": {
              "type": "string",
              "description": "プロパティ値"
            }
          },
          "required": [
            "name",
            "value"
          ]
        },
        "description": "追加特性"
      }
    },
    "required": [
      "branchCode"
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

販売者検索
GET`/seller/search{?page,limit}`

URI Parameters

HideShow

page: number (optional) Default: `1 Example: 1
ページ
limit: number (optional) Default: `100 Example: 10
最大取得件数

対応決済方法区分検索 ¶

GET https://example.com/xxxx/seller/searchPaymentAccepted?page=1&limit=10&id=xxx

Responses200400

Headers

Content-Type: application/json

Body

[
  {
    "name": {
      "ja": "xxx",
      "en": "xxx"
    },
    "codeValue": "xxx"
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "name": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "名称（日本語）"
          },
          "en": {
            "type": "string",
            "description": "名称（英語）"
          }
        },
        "required": [
          "ja",
          "en"
        ]
      },
      "codeValue": {
        "type": "string",
        "description": "区分コード"
      }
    },
    "required": [
      "codeValue"
    ]
  }
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

対応決済方法区分検索
GET`/seller/searchPaymentAccepted{?page,limit,id}`

URI Parameters

HideShow

id: string (required) Example: xxx
販売者id
page: number (optional) Default: `1 Example: 1
ページ
limit: number (optional) Default: `100 Example: 10
最大取得件数

提供決済サービス検索 ¶

GET https://example.com/xxxx/seller/searchPaymentServices?page=1&limit=10&id=xxx

Responses200400

Headers

Content-Type: application/json

Body

[
  {
    "name": {
      "ja": "xxx",
      "en": "xxx"
    },
    "id": "xxx",
    "serviceType": {
      "codeValue": "xxx"
    }
  }
]

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "name": {
        "type": "object",
        "properties": {
          "ja": {
            "type": "string",
            "description": "名称（日本語）"
          },
          "en": {
            "type": "string",
            "description": "名称（英語）"
          }
        },
        "required": [
          "ja",
          "en"
        ]
      },
      "id": {
        "type": "string",
        "description": "決済サービスid"
      },
      "serviceType": {
        "type": "object",
        "properties": {
          "codeValue": {
            "type": "string",
            "description": "区分コード"
          }
        },
        "required": [
          "codeValue"
        ]
      }
    }
  }
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

提供決済サービス検索
GET`/seller/searchPaymentServices{?page,limit,id}`

URI Parameters

HideShow

id: string (required) Example: xxx
販売者id
page: number (optional) Default: `1 Example: 1
ページ
limit: number (optional) Default: `100 Example: 10
最大取得件数

取引 ¶

取引開始 ¶

POST https://example.com/xxxx/transaction/placeOrder/start

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "seller": {
    "id": "xxx"
  },
  "object": {
    "passport": {
      "token": "xxx"
    }
  },
  "agent": {
    "identifier": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ]
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "object": {
      "type": "object",
      "properties": {
        "passport": {
          "type": "object",
          "properties": {
            "token": {
              "type": "string",
              "description": "パスポート token"
            }
          }
        }
      }
    },
    "seller": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "販売者 id"
        }
      },
      "required": [
        "id"
      ]
    },
    "agent": {
      "type": "object",
      "properties": {
        "identifier": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "プロパティ名 (最小長 8)"
              },
              "value": {
                "type": "string",
                "description": "プロパティ値"
              }
            },
            "required": [
              "name",
              "value"
            ]
          },
          "description": "購入者情報"
        }
      }
    }
  }
}

Responses200400

Headers

Content-Type: application/json

Body

{
  "id": "xxx",
  "expires": "2023-01-01T00:00:00.000Z"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "取引 id"
    },
    "expires": {
      "type": "string",
      "description": "取引期限 ISO 8601 date format"
    }
  },
  "required": [
    "id",
    "expires"
  ]
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

取引開始
POST`/transaction/placeOrder/start`

購入者情報予約語

type	description
userAgent	ユーザーエージェント
application:version	アプリケーションバージョン
application:posId	POS コード
application:posName	POS 名称

取引確定 ¶

PUT https://example.com/xxxx/transaction/placeOrder/confirm

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "id": "xxx",
  "sendEmailMessage": true,
  "email": {
    "about": "予約完了のお知らせ",
    "template": "| ご購入ありがとうございます。\\n| 確認番号: #{order.confirmationNumber}\\n| 注文番号: #{order.orderNumber}"
  },
  "seller": {
    "id": "xxx"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "取引 id"
    },
    "sendEmailMessage": {
      "type": "boolean",
      "description": "注文配送メール送信フラグ"
    },
    "email": {
      "type": "object",
      "properties": {
        "about": {
          "type": "string",
          "description": "件名"
        },
        "template": {
          "type": "string",
          "description": "本文テンプレート"
        }
      },
      "required": [
        "about",
        "template"
      ]
    },
    "seller": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "販売者 id"
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "required": [
    "id",
    "sendEmailMessage"
  ]
}

Responses200400

Headers

Content-Type: application/json

Body

{
  "confirmationNumber": "xxx",
  "orderNumber": "xxx"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "confirmationNumber": {
      "type": "string",
      "description": "確認番号"
    },
    "orderNumber": {
      "type": "string",
      "description": "注文番号"
    }
  },
  "required": [
    "confirmationNumber",
    "orderNumber"
  ]
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

取引確定
PUT`/transaction/placeOrder/confirm`

メール本文をカスタマイズしたい場合、PUG テンプレートを指定

参考 -> https://pugjs.org/api/getting-started.html

挿入変数として下記を使用できます。

variable	description
order.confirmationNumber	確認番号
order.orderNumber	注文番号

取引中止 ¶

PUT https://example.com/xxxx/transaction/placeOrder/cancel

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "id": "xxx",
  "seller": {
    "id": "xxx"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "取引 id"
    },
    "seller": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "販売者 id"
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "required": [
    "id"
  ]
}

Responses200

This response has no content.

取引中止
PUT`/transaction/placeOrder/cancel`

イベントオファー承認 ¶

POST https://example.com/xxxx/transaction/placeOrder/authorizeSeatReservation

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "object": {
    "reservationFor": {
      "id": "xxx"
    },
    "acceptedOffer": [
      {
        "id": "xxx",
        "itemOffered": {
          "serviceOutput": {
            "reservedTicket": {
              "ticketedSeat": {
                "seatNumber": "xxx",
                "seatSection": "xxx",
                "seatingType": [
                  "xxx"
                ]
              }
            },
            "additionalProperty": [
              {
                "name": "xxx",
                "value": "xxx"
              }
            ]
          },
          "subReservation": [
            {
              "ticketedSeat": {
                "seatNumber": "xxx",
                "seatSection": "xxx",
                "seatingType": [
                  "xxx"
                ]
              }
            }
          ]
        },
        "addOn": [
          {
            "id": "xxx",
            "priceSpecification": {
              "referenceQuantity": {
                "value": 1
              }
            }
          }
        ],
        "priceSpecification": {
          "appliesToMovieTicket": [
            {
              "identifier": "xxx",
              "serviceOutput": {
                "typeOf": "xxx"
              }
            }
          ]
        }
      }
    ]
  },
  "purpose": {
    "id": "xxx"
  },
  "seller": {
    "id": "xxx"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "object": {
      "type": "object",
      "properties": {
        "reservationFor": {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "イベント id"
            }
          },
          "required": [
            "id"
          ]
        },
        "acceptedOffer": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "チケットオファー id"
              },
              "itemOffered": {
                "type": "object",
                "properties": {
                  "serviceOutput": {
                    "type": "object",
                    "properties": {
                      "reservedTicket": {
                        "type": "object",
                        "properties": {
                          "ticketedSeat": {
                            "type": "object",
                            "properties": {
                              "seatNumber": {
                                "type": "string",
                                "description": "座席コード"
                              },
                              "seatSection": {
                                "type": "string",
                                "description": "セクションコード"
                              },
                              "seatingType": {
                                "type": "array",
                                "items": {
                                  "type": "string"
                                }
                              }
                            },
                            "required": [
                              "seatNumber",
                              "seatSection"
                            ]
                          }
                        }
                      },
                      "additionalProperty": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string",
                              "description": "プロパティ名"
                            },
                            "value": {
                              "type": "string",
                              "description": "プロパティ値"
                            }
                          },
                          "required": [
                            "name",
                            "value"
                          ]
                        },
                        "description": "追加特性"
                      }
                    }
                  },
                  "subReservation": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "ticketedSeat": {
                          "type": "object",
                          "properties": {
                            "seatNumber": {
                              "type": "string",
                              "description": "座席コード"
                            },
                            "seatSection": {
                              "type": "string",
                              "description": "セクションコード"
                            },
                            "seatingType": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            }
                          },
                          "required": [
                            "seatNumber",
                            "seatSection"
                          ]
                        }
                      }
                    },
                    "description": "サブ予約"
                  }
                }
              },
              "addOn": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "アドオンオファー id"
                    },
                    "priceSpecification": {
                      "type": "object",
                      "properties": {
                        "referenceQuantity": {
                          "type": "object",
                          "properties": {
                            "value": {
                              "type": "number",
                              "description": "数量指定"
                            }
                          },
                          "required": [
                            "value"
                          ]
                        }
                      }
                    }
                  },
                  "required": [
                    "id"
                  ]
                }
              },
              "priceSpecification": {
                "type": "object",
                "properties": {
                  "appliesToMovieTicket": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "identifier": {
                          "type": "string",
                          "description": "適用決済カード識別子"
                        },
                        "serviceOutput": {
                          "type": "object",
                          "properties": {
                            "typeOf": {
                              "type": "string",
                              "description": "決済方法区分"
                            }
                          },
                          "required": [
                            "typeOf"
                          ]
                        }
                      },
                      "required": [
                        "identifier",
                        "serviceOutput"
                      ]
                    }
                  }
                }
              }
            },
            "required": [
              "id"
            ]
          }
        }
      },
      "required": [
        "reservationFor",
        "acceptedOffer"
      ]
    },
    "purpose": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "取引 id"
        }
      },
      "required": [
        "id"
      ]
    },
    "seller": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "販売者 id"
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "required": [
    "object",
    "purpose",
    "seller"
  ]
}

Responses200400

Headers

Content-Type: application/json

Body

{
  "id": "xxx"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "アクション id"
    }
  },
  "required": [
    "id"
  ]
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

イベントオファー承認
POST`/transaction/placeOrder/authorizeSeatReservation`

イベントオファー承認取り消し ¶

PUT https://example.com/xxxx/transaction/placeOrder/voidSeatReservation

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "id": "xxx",
  "purpose": {
    "id": "xxx"
  },
  "seller": {
    "id": "xxx"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "アクション id"
    },
    "purpose": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "取引 id"
        }
      },
      "required": [
        "id"
      ]
    },
    "seller": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "販売者 id"
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "required": [
    "id"
  ]
}

Responses200400

Headers

Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

イベントオファー承認取り消し
PUT`/transaction/placeOrder/voidSeatReservation`

取引人プロフィール設定 ¶

PUT https://example.com/xxxx/transaction/placeOrder/setProfile

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "id": "xxx",
  "agent": {
    "familyName": "xxx",
    "givenName": "xxx",
    "email": "xxx@xxx.com",
    "telephone": "+819012345678",
    "additionalProperty": [
      {
        "name": "xxx",
        "value": "xxx"
      }
    ]
  },
  "seller": {
    "id": "xxx"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "取引 id"
    },
    "agent": {
      "type": "object",
      "properties": {
        "familyName": {
          "type": "string",
          "description": "姓"
        },
        "givenName": {
          "type": "string",
          "description": "名"
        },
        "email": {
          "type": "string",
          "description": "メールアドレス"
        },
        "telephone": {
          "type": "string",
          "description": "電話番号 E.164"
        },
        "additionalProperty": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "プロパティ名"
              },
              "value": {
                "type": "string",
                "description": "プロパティ値"
              }
            },
            "required": [
              "name",
              "value"
            ]
          },
          "description": "追加特性"
        }
      },
      "required": [
        "familyName",
        "givenName",
        "email",
        "telephone"
      ]
    },
    "seller": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "販売者 id"
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "required": [
    "id"
  ]
}

Responses200400

This response has no content.

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

取引人プロフィール設定
PUT`/transaction/placeOrder/setProfile`

返品取引 ¶

取引開始 ¶

POST https://example.com/xxxx/transaction/returnOrder/start

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "object": {
    "order": [
      {
        "orderNumber": "xxx",
        "confirmationNumber": "xxx"
      }
    ]
  },
  "seller": {
    "id": "xxx"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "object": {
      "type": "object",
      "properties": {
        "order": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "orderNumber": {
                "type": "string",
                "description": "注文番号"
              },
              "confirmationNumber": {
                "type": "string",
                "description": "確認番号"
              }
            },
            "required": [
              "orderNumber",
              "confirmationNumber"
            ]
          }
        }
      }
    },
    "seller": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "販売者 id"
        }
      },
      "required": [
        "id"
      ]
    }
  }
}

Responses200400

Headers

Content-Type: application/json

Body

{
  "id": "xxx",
  "expires": "2023-01-01T00:00:00.000Z"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "取引 id"
    },
    "expires": {
      "type": "string",
      "description": "取引期限 ISO 8601 date format"
    }
  },
  "required": [
    "id",
    "expires"
  ]
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

取引開始
POST`/transaction/returnOrder/start`

取引確定 ¶

PUT https://example.com/xxxx/transaction/returnOrder/confirm

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "id": "xxx",
  "potentialActions": {
    "returnOrder": {
      "potentialActions": {
        "sendEmailMessage": [
          {
            "object": {
              "about": "返品完了のお知らせ",
              "template": "| 返品完了しました。\\n| 確認番号: #{order.confirmationNumber}\\n| 注文番号: #{order.orderNumber}"
            }
          }
        ]
      }
    }
  },
  "seller": {
    "id": "xxx"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "取引 id"
    },
    "potentialActions": {
      "type": "object",
      "properties": {
        "returnOrder": {
          "type": "object",
          "properties": {
            "potentialActions": {
              "type": "object",
              "properties": {
                "sendEmailMessage": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "object": {
                        "type": "object",
                        "properties": {
                          "about": {
                            "type": "string",
                            "description": "件名"
                          },
                          "template": {
                            "type": "string",
                            "description": "本文テンプレート"
                          }
                        },
                        "required": [
                          "about",
                          "template"
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "seller": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "販売者 id"
        }
      },
      "required": [
        "id"
      ]
    }
  },
  "required": [
    "id"
  ]
}

Responses200400

Headers

Content-Type: application/json

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

取引確定
PUT`/transaction/returnOrder/confirm`

メール本文をカスタマイズしたい場合、PUG テンプレートを指定

参考 -> https://pugjs.org/api/getting-started.html

挿入変数として下記を使用できます。

variable	description
order.confirmationNumber	確認番号
order.orderNumber	注文番号

パスポート ¶

パスポート取得 ¶

POST https://example.com/xxxx/passports

Requestsexample 1

Headers

Content-Type: application/json

Body

{
  "scope": "Transaction:PlaceOrder:xxx"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "description": "スコープ"
    }
  },
  "required": [
    "scope"
  ]
}

Responses200400

Headers

Content-Type: application/json

Body

{
  "token": "xxx"
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "token": {
      "type": "string",
      "description": "パスポートトークン"
    }
  },
  "required": [
    "token"
  ]
}

Headers

Content-Type: application/json

Body

{
  "error": {
    "code": 400,
    "errors": [
      {
        "message": "message",
        "name": "SomeError",
        "reason": "Argument"
      }
    ],
    "message": "message"
  }
}

Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "HTTPステータスコード"
        },
        "errors": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "message": {
                "type": "string",
                "description": "エラーメッセージ"
              },
              "name": {
                "type": "string",
                "description": "エラー名称"
              },
              "reason": {
                "type": "string",
                "description": "エラー原因"
              }
            },
            "required": [
              "message",
              "name",
              "reason"
            ]
          },
          "description": "エラーリスト"
        },
        "message": {
          "type": "string",
          "description": "エラーメッセージ"
        }
      },
      "required": [
        "code",
        "message"
      ]
    }
  }
}

パスポート取得
POST`/passports`

スコープ

type	description
Transaction:PlaceOrder:販売者 id	取引

Generated by aglio on 10 Dec 2025

API Endpoint

リクエストクォータ ¶

レートクォータ ¶

同時実行クォータ ¶

ステータスコード ¶

Error response ¶

OAuth ¶

アクセストークン ¶

Headers

Body

Schema

Headers

Body

Schema

Headers

Body

Schema

アクセストークン発行POST/oauth2/token

区分 ¶

区分検索 ¶

Headers

Body

Schema

Headers

Body

Schema

区分検索GET/categoryCode/search{?page,limit,categorySetIdentifier,sellerId}

コンテンツ ¶

コンテンツ検索 ¶

Headers

Body

Schema

Headers

Body

Schema

コンテンツ検索GET/creativeWork/searchMovies{?page,limit,identifiers,sellerId}

配送 ¶

同期的に注文配送 ¶

Headers

Body

Schema

Headers

Headers

Body

Schema

同期的に注文配送POST/deliver/sendOrder

イベント ¶

イベント検索 ¶

Headers

Body

Schema

Headers

Body

Schema

イベント検索GET/event/screeningEvent/search{?page,limit,startFrom,startThrough,superEventLocationBranchCodes,clientId,ids,sellerId}

イベントオファー検索 ¶

Headers

Body

Schema

Headers

Body

Schema

イベントオファー検索GET/event/screeningEvent/searchTicketOffers{?page,limit,eventId,sellerId}

座席ステータス検索 ¶

Headers

Body

Schema

Headers

Body

Schema

座席ステータス検索GET/event/screeningEvent/searchSeats{?page,limit,eventId,sellerId}

施設コンテンツ検索 ¶

Headers

Body

Schema

Headers

Body

Schema

施設コンテンツ検索GET/event/screeningEventSeries/search{?page,limit,startFrom,startThrough,endFrom,endThrough,locationBranchCode,workPerformedIdentifier,sellerId}

注文 ¶

リクエストクォータ

レートクォータ

同時実行クォータ

ステータスコード

Error response

アクセストークン発行
POST`/oauth2/token`

区分検索
GET`/categoryCode/search{?page,limit,categorySetIdentifier,sellerId}`

コンテンツ検索
GET`/creativeWork/searchMovies{?page,limit,identifiers,sellerId}`

同期的に注文配送
POST`/deliver/sendOrder`

イベント検索
GET`/event/screeningEvent/search{?page,limit,startFrom,startThrough,superEventLocationBranchCodes,clientId,ids,sellerId}`

イベントオファー検索
GET`/event/screeningEvent/searchTicketOffers{?page,limit,eventId,sellerId}`

座席ステータス検索
GET`/event/screeningEvent/searchSeats{?page,limit,eventId,sellerId}`

施設コンテンツ検索
GET`/event/screeningEventSeries/search{?page,limit,startFrom,startThrough,endFrom,endThrough,locationBranchCode,workPerformedIdentifier,sellerId}`

確認番号で注文検索
GET`/order/findByConfirmationNumber{?confirmationNumber,telephone}`

注文アイテム検索
GET`/order/searchAcceptedOffersByConfirmationNumber{?page,limit,confirmationNumber,orderNumber,sellerId}`

注文コード発行
POST`/order/authorize`

同期的に注文作成
POST`/order/placeOrder`

施設検索
GET`/place/searchMovieTheaters{?page,limit,sellerId}`

ルーム検索
GET`/place/searchScreeningRooms{?page,limit,sellerId}`

プロダクト検索
GET`/product/search{?page,limit,typeOf,sellerId}`