APIリファレンス

GraphQL API documentation for makeshop apps developers

Contact

apps developer support

https://developers.makeshop.jp/contact/

API Endpoints
https://アプリ開発・公開申請のお手続き完了メールにて通知しております

APIリクエスト

エンドポイント

POST https://アプリ開発・公開申請のお手続き完了メールにて通知しております
APIリクエストには、以下をリクエストヘッダに含めてください。
リクエストサイズが5MB以上の場合はリクエストを受け付けない場合が有ります。

パラメータ 値 説明
content-type application/json 画像登録が有る場合は設定不可です。
authorization Bearer PAT.192a522c36a92af...
※永続トークンの入力例		 永続トークンもしくは一時トークンを入力してください。

▼永続トークン取得方法
アプリのインストール時にインストールWebhookURLへ通知します。
※アプリをアンインストールするとTokenは失効いたします。
※アプリをアンインストールするとTokenは失効いたします。

▼一時トークン取得方法
SSO(シングルサインオン)をご確認ください。
x-api-key 2215a0c0f32e631a360... APIキーを入力してください。

▼取得方法
「アプリ開発申請」「アプリ公開申請」後に発行し通知しております。
x-timestamp 1692613424 Unixtimeを入力してください。
有効期限は1時間となります。
※インストール数および実行時間増加の際の有効期限切れ考慮のため、1回のAPIコール前にx-timestamp生成をいただく等の実装をご検討ください。

都道府県コード対応表

各APIの都道府県コードの対応表となります

番号 都道府県
1 北海道
2 青森県
3 岩手県
4 宮城県
5 秋田県
6 山形県
7 福島県
8 茨城県
9 栃木県
10 群馬県
11 埼玉県
12 千葉県
13 東京（23区内）
14 東京（23区外）
15 神奈川県
16 新潟県
17 富山県
18 石川県
19 福井県
20 山梨県
21 長野県
22 岐阜県
23 静岡県
24 愛知県
25 三重県
26 滋賀県
27 京都府
28 大阪府
29 兵庫県
30 奈良県
31 和歌山県
32 鳥取県
33 島根県
34 岡山県
35 広島県
36 山口県
37 徳島県
38 香川県
39 愛媛県
40 高知県
41 福岡県
42 佐賀県
43 長崎県
44 熊本県
45 大分県
46 宮崎県
47 鹿児島県
48 沖縄県
49 離島部
50 海外

決済方法コード対応表

各APIの決済方法コードの対応表となります

決済方法コード 決済方法名 備考
B 銀行振込
P 任意決済
R 代金引換
N NP後払い
A 後払い.com
C クレジットカード（イプシロン）
T クレジットカード（ペイジェント）
Y クレジットカード（ペイメントゲートウェイ） クレジットカード（SMBCマルチペイメント）の場合も本コードに該当します。
V ネットバンク（イプシロン）
Z コンビニ決済（イプシロン）
F コンビニ決済（ペイメントゲートウェイ） コンビニ決済（SMBCマルチペイメント）の場合も本コードに該当します。
L PayPal（イプシロン）
O Yahoo!ウォレット（イプシロン）
Q キャリア決済（イプシロン）
S WeBBy
M Paid決済（後払い決済）
X 決済不要
U キャリア決済（ペイメントゲートウェイ） キャリア決済（SMBCマルチペイメント）の場合も本コードに該当します。
A1 Amazonマーケットプレイス決済
A2 Amazonマーケットプレイス決済(代引き)
B1 GMO後払い（イプシロン）
C1 あと払い（ペイディ）
D1 Amazon Pay（イプシロン）
E1 NP掛け払い（旧FREX B2B後払い）
F1 リクルートかんたん支払い
G1 楽天ペイ（イプシロン）
H1 ZEUSクレジット
I1 クレジットカード（クロネコwebコレクト）
J1 コンビニ決済（クロネコwebコレクト）
K1 クロネコ代金後払い
L1 atone
M1 銀行振込（バーチャル口座）決済（イプシロン）
N1 LINE Pay
O1 PayPay（イプシロン）
P1 クロネコ クレカ払い（旧クロネコペイ）
Q1 GMO後払い（ペイメントサービス）
Y1 Yahoo!ショッピングカード決済
Y2 Yahoo!ショッピングPayPay残高払い
Y3 Yahoo!ショッピングPayPayあと払い
Y9 Yahoo!ショッピング（全額ポイント）

Queries

getAccessBodyTag

Description

アクセス解析タグ(bodyタグ)取得

Response

Returns a GetAccessTagResponse!

Arguments
Name Description
input - GetAccessTagRequest!

Example

Query
query getAccessBodyTag($input: GetAccessTagRequest!) {
  getAccessBodyTag(input: $input) {
    accessTag {
      tag
      key
    }
  }
}
Variables
{"input": GetAccessTagRequest}
Response
{"data": {"getAccessBodyTag": {"accessTag": AccessTag}}}
Queries

getAccessHeadTag

Description

アクセス解析タグ(headタグ)取得

Response

Returns a GetAccessTagResponse!

Arguments
Name Description
input - GetAccessTagRequest!

Example

Query
query getAccessHeadTag($input: GetAccessTagRequest!) {
  getAccessHeadTag(input: $input) {
    accessTag {
      tag
      key
    }
  }
}
Variables
{"input": GetAccessTagRequest}
Response
{"data": {"getAccessHeadTag": {"accessTag": AccessTag}}}
Queries

getAppChargeReservation

Description

自由決済予約取得

Response

Returns an AppChargeReservation

Arguments
Name Description
input - GetAppChargeReservationRequest!

Example

Query
query getAppChargeReservation($input: GetAppChargeReservationRequest!) {
  getAppChargeReservation(input: $input) {
    appChargeReservationId
    reservationDate
    name
    status
    totalPrice
    totalTaxedPrice
    details {
      appChargeReservationDetailId
      name
      price
      taxRate
      taxedPrice
    }
  }
}
Variables
{"input": GetAppChargeReservationRequest}
Response
{
  "data": {
    "getAppChargeReservation": {
      "appChargeReservationId": 867,
      "reservationDate": "2023-07-01",
      "name": "アプリ内課金",
      "status": "UNPROCESSED",
      "totalPrice": 10000,
      "totalTaxedPrice": 11000,
      "details": [AppChargeReservationDetail]
    }
  }
}
Queries

getAppSubscriptionSettlementStatus

Description

アプリサブスクリプション決済ステータス取得

Response

Returns a GetAppSubscriptionSettlementStatusResponse!

Example

Query
query getAppSubscriptionSettlementStatus {
  getAppSubscriptionSettlementStatus {
    status
  }
}
Response
{"data": {"getAppSubscriptionSettlementStatus": {"status": "OK"}}}
Queries

getAppSubscriptionStatus

Description

アプリサブスクリプションステータス取得

Response

Returns a GetAppSubscriptionStatusResponse!

Example

Query
query getAppSubscriptionStatus {
  getAppSubscriptionStatus {
    status
  }
}
Response
{"data": {"getAppSubscriptionStatus": {"status": "IN_USE"}}}
Queries

getShop

Description

ショップ情報取得

Response

Returns a GetShopResponse!

Example

Query
query getShop {
  getShop {
    shop {
      shopId
      shopName
      shopUrl
      shopStaffName
      applicantName
      applicantKana
      applicantEmail
      applicantTel
      companyType
      companyName
      companyOwnerName
      companyPostalAddress
      companyAddress
      settingOriginalDomain
      settingAlwaysSSL
      openCondition
      googleShoppingEntry
      googleShoppingShopName
      contact {
        mailAddress
        tel
        address
        fromName
        orderMailAddressList
        stockAlarmMailAddressList
        stockManagementSystemOrderMailAddress
      }
      companyOverview {
        pcText
        spText
      }
      isCreatorMode
      enddate
    }
    member {
      addEntryFields {
        number
        name
        maxLength
        required
      }
      point {
        settingPointSystem
        expirationMonth
        newMemberBonusPoint
        applyStandardValue
        settingPointUsageLimit
        usePointLimit
        usePointTarget
        addTimingDate
        settingMemberIntroductionSystem
        introducedBonusPoint
        introducedMeBonusPoint
        referee
      }
    }
    order {
      settingTaxIncludedExcluded
      settingTaxExcludedFraction
      orderMinAmount
      settingZeroBuy
      settingNonCancelTiming
    }
    settlement {
      bank {
        settingBank
      }
      bankPost {
        settingBankPost
      }
      cashOnDelivery {
        settingCashOnDelivery
      }
      epsilon {
        settingCreditCard
        settingConvenience
        settingCarrier
        settingVirtualBank
        settingAmazonPay
        settingRakuten
        settingYahooWallet
        settingPayPal
        settingNetBank
        settingGmoPayLater
        settingPayPay
      }
      gmoPg {
        settingCreditCard
        settingConvenience
        settingRecruit
        settingCarrier
      }
      gmoPs {
        settingPayLater
        settingPayLaterFees {
          minAmount
          maxAmount
          fee
        }
      }
      sgp {
        settingCreditCard
        settingConvenience
        settingCarrier
      }
      np {
        settingPayLater
        settingPayLaterFee
        settingLumpSumPay
        settingAtone
        settingSalesProcessing
        settingAtoneUpdateOption
      }
      yamato {
        kuronekoWebCollectCreditCard {
          settingCreditCard
          settingDeliveryCompany
          settingPayment {
            settingLumpSum
            settingInstallments
            settingRevolving
          }
          settingCardSave
          settingSecure
          settingReCredit
          settingCreditSaveDay
          settingReCreditTiming
        }
        kuronekoWebCollectConvenience {
          settingConvenience
          settingConvenienceFees {
            minAmount
            maxAmount
            fee
          }
        }
        kuronekoCreditCard {
          settingKuronekoCreditCard
          settingPayment {
            settingLumpSum
            settingInstallments
            settingRevolving
          }
          settingSecure
        }
        kuronekoPayLater {
          settingKuronekoPayLater
          settingDeliveryCompany
          settingPayLaterFees {
            minAmount
            maxAmount
            fee
          }
        }
      }
      linePay {
        settingLinePay
        settingSalesProcessing
      }
      paidy {
        settingPaidy
      }
      payLaterCom {
        settingPayLaterCom
        settingAutoLink
        settingPayLaterComFees {
          minAmount
          maxAmount
          fee
        }
      }
      zeus {
        settingCreditCard
        settingPayment {
          settingLumpSum
          settingTwo
          settingInstallments
          settingRevolving
          settingBonus
        }
        settingSalesProcessing
        settingSecure
        settingCardSave
        settingSecurityCode
      }
      paygent {
        settingPaygentCreditCard
        settingCardSave
      }
      paidPayLater {
        settingPaidPayLater
      }
      webby {
        settingWebby
      }
    }
  }
}
Response
{
  "data": {
    "getShop": {
      "shop": ShopBasic,
      "member": ShopMember,
      "order": ShopOrder,
      "settlement": ShopSettlement
    }
  }
}
Queries

getShopDeliverySetting

Description

ショップ配送設定情報取得

Response

Returns a GetShopDeliverySettingResponse!

Example

Query
query getShopDeliverySetting {
  getShopDeliverySetting {
    delivery {
      settingDeliveryMethods {
        settingId
        settingName
        settingDisplay
        settingShippingFee
        settingShippingFeeMember
        shippingFeeMemberDiscount
        settingAreaShippingFees {
          areaName
          feeByArea
          feeByOrderAmounts {
            minAmount
            maxAmount
            fee
          }
          feeByWeights {
            minWeight
            maxWeight
            fee
          }
          feeByOrderQuantitys {
            minQuantity
            maxQuantity
            fee
          }
        }
        cashOnDelivery {
          settingCashOnDelivery
          settingCashOnDeliveryMemberFee
          cashOnDeliveryPaymentAmountLimit
          settingCashOnDeliveryFeeMethod
          settingCashOnDeliveryFees {
            minAmount
            maxAmount
            fee
          }
          settingMemberGroupCashOnDeliveryFees {
            memberGroupId
            settingCashOnDeliveryFees {
              minAmount
              maxAmount
              fee
            }
          }
        }
      }
      settingDeliveryDate {
        settingDesiredDeliveryDate {
          settingDisplay
          required
          lowerLimit
          upperLimit
          initialDisplay
          standardTime
        }
        settingDeliveryDays {
          areaName
          leadTimeDays
        }
        settingDeliveryHolidays
        settingDeliveryTime {
          settingUse
          timeType
        }
        settingDeliveryAreas {
          groupName
          areas {
            areaName
            zipCodes
          }
        }
      }
    }
  }
}
Response
{
  "data": {
    "getShopDeliverySetting": {"delivery": Delivery}
  }
}
Queries

getShopOrderPrint

Description

ショップ納品明細書情報取得

Response

Returns a GetShopOrderPrintResponse!

Example

Query
query getShopOrderPrint {
  getShopOrderPrint {
    orderPrint {
      invoiceNum
    }
  }
}
Response
{
  "data": {
    "getShopOrderPrint": {"orderPrint": OrderPrint}
  }
}
Queries

getShopSignatureImage

Description

ショップ社印画像取得

Response

Returns a GetShopSignatureImageResponse!

Example

Query
query getShopSignatureImage {
  getShopSignatureImage {
    signatureImageUrl
  }
}
Response
{
  "data": {
    "getShopSignatureImage": {
      "signatureImageUrl": "https://shop〇〇.makeshop.jp/shopimages/ショップID/orderSealImpression729256.jpg"
    }
  }
}
Queries

searchAccessBodyTag

Description

アクセス解析タグ(bodyタグ)全取得

Response

Returns a SearchAccessTagResponse!

Arguments
Name Description
input - SearchAccessTagRequest

Example

Query
query searchAccessBodyTag($input: SearchAccessTagRequest) {
  searchAccessBodyTag(input: $input) {
    accessTags {
      tag
      key
    }
  }
}
Variables
{"input": SearchAccessTagRequest}
Response
{
  "data": {
    "searchAccessBodyTag": {"accessTags": [AccessTag]}
  }
}
Queries

searchAccessHeadTag

Description

アクセス解析タグ(headタグ)全取得

Response

Returns a SearchAccessTagResponse!

Arguments
Name Description
input - SearchAccessTagRequest

Example

Query
query searchAccessHeadTag($input: SearchAccessTagRequest) {
  searchAccessHeadTag(input: $input) {
    accessTags {
      tag
      key
    }
  }
}
Variables
{"input": SearchAccessTagRequest}
Response
{
  "data": {
    "searchAccessHeadTag": {"accessTags": [AccessTag]}
  }
}
Queries

searchAppPayment

Description

アプリ決済情報取得

Response

Returns a SearchAppPaymentResponse!

Arguments
Name Description
input - SearchAppPaymentRequest

Example

Query
query searchAppPayment($input: SearchAppPaymentRequest) {
  searchAppPayment(input: $input) {
    paymentInfos {
      status
      type
      salesDate
      price
      tax
      totalPrice
      fincodeOrderId
      planInfo {
        id
        name
        fincodePlanId
      }
      paymentDetails {
        amount
        tax
        taxRate
        totalPrice
        kind
        targetPeriodFrom
        targetPeriodTo
      }
    }
    searchedCount
    page
    limit
  }
}
Variables
{"input": SearchAppPaymentRequest}
Response
{
  "data": {
    "searchAppPayment": {
      "paymentInfos": [PaymentInfo],
      "searchedCount": 3,
      "page": 1,
      "limit": 1000
    }
  }
}
Queries

searchCoupon

Description

クーポン情報取得

Response

Returns a SearchCouponResponse!

Arguments
Name Description
input - SearchCouponRequest!

Example

Query
query searchCoupon($input: SearchCouponRequest!) {
  searchCoupon(input: $input) {
    page
    limit
    searchedCount
    coupons {
      code
      name
      isEnabled
      isForOnlyMember
      maximumMemberUsableCount
      memberGroupIds
      minimumPrice
      totalUseCount
      usedCount
      isTargetProduct
      discountType
      fixedAmount
      fixedRate
      startedAt
      endedAt
      isCreatedExternally
      updatedAt
    }
  }
}
Variables
{"input": SearchCouponRequest}
Response
{
  "data": {
    "searchCoupon": {
      "page": 1,
      "limit": 10,
      "searchedCount": 100,
      "coupons": [SearchCouponInfo]
    }
  }
}
Queries

searchCouponProduct

Description

クーポン対象商品一覧取得

Response

Returns a SearchCouponProductResponse!

Arguments
Name Description
input - SearchCouponProductRequest!

Example

Query
query searchCouponProduct($input: SearchCouponProductRequest!) {
  searchCouponProduct(input: $input) {
    code
    productCodes
    searchedCount
    page
    limit
  }
}
Variables
{"input": SearchCouponProductRequest}
Response
{
  "data": {
    "searchCouponProduct": {
      "code": "coupon",
      "productCodes": ["abc123"],
      "searchedCount": 6,
      "page": 1,
      "limit": 1000
    }
  }
}
Queries

searchMember

Description

会員情報取得

Response

Returns a SearchMemberResponse!

Arguments
Name Description
input - SearchMemberRequest!

Example

Query
query searchMember($input: SearchMemberRequest!) {
  searchMember(input: $input) {
    members {
      groupId
      groupName
      memberId
      name
      nameKana
      email
      mailMagazineFlag
      sex
      birthday
      shopPoint
      reserveExpireDate
      recommendId
      hpost
      haddress1
      haddressAddr
      haddress2
      haddress
      tel
      fax
      etcphone
      hpEmail
      officename
      officenameKana
      officedept
      opost
      oaddress1
      oaddressAddr
      oaddress
      ophone
      etc
      confirm
      registrationDate
      shopMemo
      modified
      delFlag
      memberFlag
      lockStatusFlag
      lockTime
      lockClearApplyTime
      externalUsers {
        service
        id
      }
      loginEmailAuth
    }
    searchedCount
    displayRecordFrom
    displayRecordTo
    page
    limit
  }
}
Variables
{"input": SearchMemberRequest}
Response
{
  "data": {
    "searchMember": {
      "members": [MemberInfo],
      "searchedCount": 1,
      "displayRecordFrom": 1,
      "displayRecordTo": 1,
      "page": 1,
      "limit": 1000
    }
  }
}
Queries

searchOrder

Description

注文情報取得

Response

Returns a SearchOrderResponse!

Arguments
Name Description
input - SearchOrderRequest!

Example

Query
query searchOrder($input: SearchOrderRequest!) {
  searchOrder(input: $input) {
    orders {
      systemOrderNumber
      displayOrderNumber
      memberId
      orderDate
      modified
      sumPrice
      sumPriceOrg
      excludedSumTax
      taxCalculationType
      priceInfoPerTaxRate {
        taxRate
        tax
        taxIncludedPrice
      }
      memberGroupPoint
      cashDiscountAmount
      reserve
      couponInfo {
        couponName
        couponCode
        couponDiscount
      }
      revisedPrice
      bulkPurchaseDiscount
      discountPerTax {
        taxRate
        discount
      }
      payMethodCode
      payMethod
      paymentNumber
      paymentStatusCode
      paymentStatus
      paymentFeeType
      paymentFee
      cashOnDeliveryPayMethod
      paymentData
      paymentDate
      cardMultiple
      senderCompany
      senderCompanyKana
      senderCompanyDept
      senderName
      senderNameKana
      senderPost
      senderPrefecture
      senderAddress
      senderAddress2
      senderTel
      senderEmergencyTel
      senderEmail
      delFlag
      ipAddress
      userAgent
      userDeviceType
      linkId
      ordertemp
      message
      orderSubscriptionBaseId
      deliveryInfos {
        deliveryId
        deliveryStatus
        deliveryCompanyCode
        slipNumber
        deliveryDate
        deliveryMethodIds
        desiredDeliveryDate
        desiredDeliveryTimezone
        estimatedShipmentDate
        shippingCharge
        receiverCompany
        receiverCompanyKana
        receiverCompanyDept
        receiverName
        receiverNameKana
        receiverPost
        receiverPrefecture
        receiverAddress
        receiverAddress2
        receiverTel
        deliveryMessage
        wmsStatus
        wmsChangeStatus
        deliverySumPrice
        basketInfos {
          productCode
          productCustomCode
          variationCustomCode
          productName
          variationName
          variation1ItemId
          variation2ItemId
          optionCode
          addcode
          amount
          price
          taxRate
          grantedShopPoint
          addToCartDate
          discountRate
        }
      }
    }
    searchedCount
    searchedAmount
    page
    limit
  }
}
Variables
{"input": SearchOrderRequest}
Response
{
  "data": {
    "searchOrder": {
      "orders": [SearchedOrder],
      "searchedCount": 2,
      "searchedAmount": 4500,
      "page": 1,
      "limit": 1000
    }
  }
}
Queries

searchOrderSubscription

Description

定期注文情報取得

Response

Returns a SearchOrderSubscriptionResponse!

Arguments
Name Description
input - SearchOrderSubscriptionRequest!

Example

Query
query searchOrderSubscription($input: SearchOrderSubscriptionRequest!) {
  searchOrderSubscription(input: $input) {
    orderSubscriptions {
      orderInfo {
        subscriptionProduct {
          systemCode
          productName
          spName
          spName2
          amount
          sellPrice {
            price
            taxRate
            taxCalculation
            taxInclude
          }
          tax
          giftInfo {
            giftCount
            giftName
          }
        }
        orderBasicInfo {
          orderSubscriptionId
          orderSubscriptionPayMethodCode
          orderSubscriptionPayMethodName
          modified
        }
        orderSenderInfo {
          memberId
          senderName
          senderNameKana
          senderTel
          senderTel2
          senderEmail
          senderAddress {
            post
            area
            address
            address2
          }
        }
      }
      delivery {
        deliveryReceiver {
          receiverName
          receiverNameKana
          receiverTel
          receiverAddress {
            post
            area
            address
            address2
          }
        }
        deliveryInfo {
          deliveryCycleId
          deliveryCycleName
          deliveryHopeTime
          deliveryNextDatePlan
          deliveryCountNow
          deliveryMethod
          orderNextDateFix
        }
        orderRemarks {
          ItemName
          Content
        }
        memo {
          subscriotionMemo
          orderMemo
        }
      }
      orderHistories {
        ordernum
        ordernumManage
        deliveryCount
        orderHistoryCreated
        deliveryHopeDate
        payMethodCode
        payMethodName
        deliveryStatusCode
        deliveryStatusName
      }
    }
    searchedCount
    page
    limit
  }
}
Variables
{"input": SearchOrderSubscriptionRequest}
Response
{
  "data": {
    "searchOrderSubscription": {
      "orderSubscriptions": [SearchOrderSubscriptionInfo],
      "searchedCount": 2,
      "page": 1,
      "limit": 1000
    }
  }
}
Queries

searchProduct

Description

商品情報取得

Response

Returns a SearchProductResponse!

Arguments
Name Description
input - SearchProductRequest!

Example

Query
query searchProduct($input: SearchProductRequest!) {
  searchProduct(input: $input) {
    products {
      uid
      systemCode
      productName
      productGroupCode
      productGroupName
      consumerPrice
      sellPrice
      buyPrice
      taxRate
      maker
      madeIn
      keyword
      quantity
      weight
      maxImage
      maxImageUrl
      minImage
      minImageUrl
      tinyImage
      tinyImageUrl
      mobileImage
      mobileImageUrl
      mobileTinyImage
      mobileTinyImageUrl
      subImage1
      subImage1Url
      subImage2
      subImage2Url
      subImage3
      subImage3Url
      subImages {
        subImageId
        url
        seq
      }
      subImageMbCk1
      subImageMbCk2
      subImageMbCk3
      imageLayout
      isGigaPlus
      displayPosition
      summary
      etcType
      addCode
      reserve
      reserveType
      discountPeriod
      discountRate
      deli
      customCreatedAt
      updatedAt
      createdAt
      display
      customCode
      deliveryMethodId
      pcContent
      pcAddContent
      mobileContent
      mobileAddContent
      categoryContent
      isListCategoryContent
      subContent1
      subContent2
      subContent3
      seoContents
      gmoPointMultiple
      d2CProductName
      partnerProductName
      partnerProduct
      googleCategory
      partnerContent
      janCode
      isbn
      recordNumber
      mpn
      gender
      ageGroup
      skuGroup
      color
      size
      material
      design
      adwordsGroup
      adwordsLabel
      makerSaleDate
      condition
      repeatSaleType
      isReservationSale
      isRegularAfterSold
      reservationSaleDate
      reservationSaleDateNote
      arrivalDate
      reservationSaleNote
      isSellStart
      isSellEnd
      isDisplayOutOfSellPeriod
      searchProductName
      searchKeyword
      searchCustomCode
      searchMaker
      searchContent
      sellStartDateTime
      sellEndDateTime
      orderMessage
      isRestockMail
      isMemberOnly
      dmpCategoryUid
      insertNameGroup {
        groupUID
        groupName
        groupDescription
        InsertNameSettings {
          displayOrder
          adminItemName
          itemName
          isRequired
          isAlphabetOk
          isNumberOk
          isSymbolOk
          isDoubleByteCharacterOk
          inputMaxLength
          rowMaxLength
          displayRows
        }
      }
      catalogCode
      option {
        optionCode
        optionTitle
        optionSelect
        optionDefault
        optionValue0
        optionValue1
        optionValue2
        optionValue3
        optionValue4
        optionValue5
        optionValue6
        optionValue7
        optionValue8
        optionValue9
        optionValue10
        optionValue11
        optionValue12
        optionValue13
        optionValue14
        optionValue15
        optionValue16
        optionValue17
        optionValue18
        optionValue19
      }
      variationShowType
      variation1Default
      variation2Default
      variations {
        variation1ItemId
        variation1ItemName
        variation1Sort
        variation2ItemId
        variation2ItemName
        variation2Sort
        productSystemCode
        variationCustomCode
        price
        quantity
        janCode
      }
      categories {
        categoryUID
        isMainCategory
        categoryImage
        categoryName
        categoryTitle
        productDisplayType
        productDetailType
        isMembersOnly
        categorySort
        productBaseSortType
        estimateListOrder
        seoContents
        accessGroup
        isPcCategoryDisplay
        isMobileCategoryDisplay
        categoryDepth
        category1
        category2
        category3
        category4
        category5
        categoryCode
        categoryUrl
        categories {
          categoryUID
          isMainCategory
          categoryImage
          categoryName
          categoryTitle
          productDisplayType
          productDetailType
          isMembersOnly
          categorySort
          productBaseSortType
          estimateListOrder
          seoContents
          accessGroup
          isPcCategoryDisplay
          isMobileCategoryDisplay
          categoryDepth
          category1
          category2
          category3
          category4
          category5
          categoryCode
          categoryUrl
          categories {
            categoryUID
            isMainCategory
            categoryImage
            categoryName
            categoryTitle
            productDisplayType
            productDetailType
            isMembersOnly
            categorySort
            productBaseSortType
            estimateListOrder
            seoContents
            accessGroup
            isPcCategoryDisplay
            isMobileCategoryDisplay
            categoryDepth
            category1
            category2
            category3
            category4
            category5
            categoryCode
            categoryUrl
            categories {
              categoryUID
              isMainCategory
              categoryImage
              categoryName
              categoryTitle
              productDisplayType
              productDetailType
              isMembersOnly
              categorySort
              productBaseSortType
              estimateListOrder
              seoContents
              accessGroup
              isPcCategoryDisplay
              isMobileCategoryDisplay
              categoryDepth
              category1
              category2
              category3
              category4
              category5
              categoryCode
              categoryUrl
              categories {
                ...CategoryFragment
              }
            }
          }
        }
      }
      memberGroupPrices {
        groupId
        groupName
        price
        point
        pointRate
        perVariations {
          variation1ItemId
          variation1ItemName
          variation2ItemId
          variation2ItemName
          price
        }
      }
    }
    searchedCount
    searchedAmount
    page
    limit
  }
}
Variables
{"input": SearchProductRequest}
Response
{
  "data": {
    "searchProduct": {
      "products": [SearchedProduct],
      "searchedCount": 6,
      "searchedAmount": 14000,
      "page": 1,
      "limit": 1000
    }
  }
}
Queries

searchProductQuantity

Description

商品在庫情報取得

Response

Returns a SearchProductQuantityResponse!

Arguments
Name Description
input - SearchProductQuantityRequest!

Example

Query
query searchProductQuantity($input: SearchProductQuantityRequest!) {
  searchProductQuantity(input: $input) {
    productQuantities {
      systemCode
      customCode
      productName
      quantity
      variationQuantities {
        variation1Item {
          id
          name
        }
        variation2Item {
          id
          name
        }
        variationQuantity
      }
    }
    page
    limit
  }
}
Variables
{"input": SearchProductQuantityRequest}
Response
{
  "data": {
    "searchProductQuantity": {
      "productQuantities": [SearchedProductQuantity],
      "page": 1,
      "limit": 1000
    }
  }
}
Queries

searchProductSubscription

Description

定期購入商品情報取得

Response

Returns a SearchProductSubscriptionResponse!

Arguments
Name Description
input - SearchProductSubscriptionRequest!

Example

Query
query searchProductSubscription($input: SearchProductSubscriptionRequest!) {
  searchProductSubscription(input: $input) {
    productSubscriptions {
      uid
      customCode
      systemCode
      productName
      subscriptionPrice
      isDiscountUse
      discountDetails {
        numberOfDeliveries
        sellPrice
      }
      cycleDetail {
        cycleId
        cycleName
        cycleDesignate
        userDesignateSetting {
          intervalDateSetting {
            intervalDateMin
            intervalDateMax
          }
          deliveryDateSetting {
            isEveryMonth
            isEveryTwoMonths
            isEveryThreeMonths
            isMonthTwiceBuy
          }
          deliveryDayOfWeekSetting {
            isEveryMonth
            isEveryTwoMonths
            isEveryThreeMonths
          }
        }
        shopDesignateSetting {
          maxNumberOfDeliveries
          shopCycleDesignate
          intervalDateSetting {
            intervalDate
          }
          deliveryDateSetting {
            intervalMonth
            deliveryDate
            addDeliveryDate
          }
          deliveryDayOfWeekSetting {
            intervalMonth
            deliveryWeek
            deliveryDayOfWeek
          }
        }
      }
      updatedAt
    }
    searchedCount
    page
    limit
  }
}
Variables
{"input": SearchProductSubscriptionRequest}
Response
{
  "data": {
    "searchProductSubscription": {
      "productSubscriptions": [SearchProductSubscription],
      "searchedCount": 2,
      "page": 1,
      "limit": 1000
    }
  }
}

Mutations

attachCouponProduct

Description

クーポン対象商品登録API

Response

Returns an AttachCouponProductResponse!

Arguments
Name Description
input - AttachCouponProductRequest!

Example

Query
mutation attachCouponProduct($input: AttachCouponProductRequest!) {
  attachCouponProduct(input: $input) {
    results {
      code
      status
      errorMessage
    }
  }
}
Variables
{"input": AttachCouponProductRequest}
Response
{
  "data": {
    "attachCouponProduct": {
      "results": [AttachCouponProductResult]
    }
  }
}
Mutations

cancelOrder

Description

注文キャンセル

Response

Returns a CancelOrderResponse!

Arguments
Name Description
input - CancelOrderRequest!

Example

Query
mutation cancelOrder($input: CancelOrderRequest!) {
  cancelOrder(input: $input) {
    cancelOrderResults {
      displayOrderNumber
      deliveryId
      message
    }
  }
}
Variables
{"input": CancelOrderRequest}
Response
{
  "data": {
    "cancelOrder": {
      "cancelOrderResults": [CancelOrderResult]
    }
  }
}
Mutations

createAccessBodyTag

Description

アクセス解析タグ(bodyタグ)登録

Response

Returns a CreateAccessTagResponse!

Arguments
Name Description
input - CreateAccessTagRequest!

Example

Query
mutation createAccessBodyTag($input: CreateAccessTagRequest!) {
  createAccessBodyTag(input: $input) {
    accessTag {
      tag
      key
    }
  }
}
Variables
{"input": CreateAccessTagRequest}
Response
{
  "data": {
    "createAccessBodyTag": {"accessTag": AccessTag}
  }
}
Mutations

createAccessHeadTag

Description

アクセス解析タグ(headタグ)登録

Response

Returns a CreateAccessTagResponse!

Arguments
Name Description
input - CreateAccessTagRequest!

Example

Query
mutation createAccessHeadTag($input: CreateAccessTagRequest!) {
  createAccessHeadTag(input: $input) {
    accessTag {
      tag
      key
    }
  }
}
Variables
{"input": CreateAccessTagRequest}
Response
{
  "data": {
    "createAccessHeadTag": {"accessTag": AccessTag}
  }
}
Mutations

createAppChargeReservation

Description

自由決済予約登録

Response

Returns an AppChargeReservation!

Arguments
Name Description
input - CreateAppChargeReservationRequest!

Example

Query
mutation createAppChargeReservation($input: CreateAppChargeReservationRequest!) {
  createAppChargeReservation(input: $input) {
    appChargeReservationId
    reservationDate
    name
    status
    totalPrice
    totalTaxedPrice
    details {
      appChargeReservationDetailId
      name
      price
      taxRate
      taxedPrice
    }
  }
}
Variables
{"input": CreateAppChargeReservationRequest}
Response
{
  "data": {
    "createAppChargeReservation": {
      "appChargeReservationId": 867,
      "reservationDate": "2023-07-01",
      "name": "アプリ内課金",
      "status": "UNPROCESSED",
      "totalPrice": 10000,
      "totalTaxedPrice": 11000,
      "details": [AppChargeReservationDetail]
    }
  }
}
Mutations

createAppChargeReservationDetail

Description

自由決済予約明細登録

Response

Returns an AppChargeReservationDetail!

Arguments
Name Description
input - CreateAppChargeReservationDetailRequest!

Example

Query
mutation createAppChargeReservationDetail($input: CreateAppChargeReservationDetailRequest!) {
  createAppChargeReservationDetail(input: $input) {
    appChargeReservationDetailId
    name
    price
    taxRate
    taxedPrice
  }
}
Variables
{"input": CreateAppChargeReservationDetailRequest}
Response
{
  "data": {
    "createAppChargeReservationDetail": {
      "appChargeReservationDetailId": 1,
      "name": "アイテム購入",
      "price": 1000,
      "taxRate": 10,
      "taxedPrice": 1100
    }
  }
}
Mutations

createCoupon

Description

クーポン登録

Response

Returns a CreateCouponResponse!

Arguments
Name Description
input - CreateCouponRequest!

Example

Query
mutation createCoupon($input: CreateCouponRequest!) {
  createCoupon(input: $input) {
    results {
      code
      name
      status
      errorMessage
    }
  }
}
Variables
{"input": CreateCouponRequest}
Response
{
  "data": {
    "createCoupon": {"results": [CreateCouponResult]}
  }
}
Mutations

createMember

Description

会員登録

Response

Returns a CreateMemberResponse!

Arguments
Name Description
input - CreateMemberRequest!

Example

Query
mutation createMember($input: CreateMemberRequest!) {
  createMember(input: $input) {
    results {
      status
      memberId
      errorMessage
    }
  }
}
Variables
{"input": CreateMemberRequest}
Response
{
  "data": {
    "createMember": {"results": [CreateMemberResult]}
  }
}
Mutations

createOrder

Description

注文情報登録
※一度のリクエストで作成できる注文件数の上限は10件となります。

Response

Returns a CreateOrderResponse!

Arguments
Name Description
input - CreateOrderRequest!

Example

Query
mutation createOrder($input: CreateOrderRequest!) {
  createOrder(input: $input) {
    orderResults {
      id
      status
      paymentRedirectUrl
      paymentAdditionalParameter {
        paReq
        mD
        termUrl
      }
      systemOrderNumber
      displayOrderNumber
      errorMessage
    }
  }
}
Variables
{"input": CreateOrderRequest}
Response
{"data": {"createOrder": {"orderResults": [OrderResult]}}}
Mutations

createProduct

Description

商品情報登録

Response

Returns a CreateProductResponse!

Arguments
Name Description
input - CreateProductRequest!

Example

Query
mutation createProduct($input: CreateProductRequest!) {
  createProduct(input: $input) {
    results {
      index
      systemCode
      message
    }
  }
}
Variables
{"input": CreateProductRequest}
Response
{
  "data": {
    "createProduct": {"results": [SaveProductResult]}
  }
}
Mutations

deleteAccessBodyTag

Description

アクセス解析タグ(bodyタグ)削除

Response

Returns a String

Arguments
Name Description
input - DeleteAccessTagRequest!

Example

Query
mutation deleteAccessBodyTag($input: DeleteAccessTagRequest!) {
  deleteAccessBodyTag(input: $input)
}
Variables
{"input": DeleteAccessTagRequest}
Response
{"data": {"deleteAccessBodyTag": "abc123"}}
Mutations

deleteAccessHeadTag

Description

アクセス解析タグ(headタグ)削除

Response

Returns a String

Arguments
Name Description
input - DeleteAccessTagRequest!

Example

Query
mutation deleteAccessHeadTag($input: DeleteAccessTagRequest!) {
  deleteAccessHeadTag(input: $input)
}
Variables
{"input": DeleteAccessTagRequest}
Response
{"data": {"deleteAccessHeadTag": "xyz789"}}
Mutations

deleteAppChargeReservation

Description

自由決済予約削除

Response

Returns a Void

Arguments
Name Description
input - DeleteAppChargeReservationRequest!

Example

Query
mutation deleteAppChargeReservation($input: DeleteAppChargeReservationRequest!) {
  deleteAppChargeReservation(input: $input)
}
Variables
{"input": DeleteAppChargeReservationRequest}
Response
{"data": {"deleteAppChargeReservation": null}}
Mutations

deleteAppChargeReservationDetail

Description

自由決済予約明細削除

Response

Returns a Void

Arguments
Name Description
input - DeleteAppChargeReservationDetailRequest!

Example

Query
mutation deleteAppChargeReservationDetail($input: DeleteAppChargeReservationDetailRequest!) {
  deleteAppChargeReservationDetail(input: $input)
}
Variables
{"input": DeleteAppChargeReservationDetailRequest}
Response
{"data": {"deleteAppChargeReservationDetail": null}}
Mutations

deleteCoupon

Description

クーポン削除API

Response

Returns a DeleteCouponResponse!

Arguments
Name Description
input - DeleteCouponRequest!

Example

Query
mutation deleteCoupon($input: DeleteCouponRequest!) {
  deleteCoupon(input: $input) {
    results {
      code
      status
      errorMessage
    }
  }
}
Variables
{"input": DeleteCouponRequest}
Response
{
  "data": {
    "deleteCoupon": {"results": [DeleteCouponResult]}
  }
}
Mutations

deleteMember

Description

会員情報削除

Response

Returns a Void

Arguments
Name Description
input - DeleteMemberRequest!

Example

Query
mutation deleteMember($input: DeleteMemberRequest!) {
  deleteMember(input: $input)
}
Variables
{"input": DeleteMemberRequest}
Response
{"data": {"deleteMember": null}}
Mutations

deleteProduct

Description

商品情報削除

Response

Returns a DeleteProductResponse!

Arguments
Name Description
input - DeleteProductRequest!

Example

Query
mutation deleteProduct($input: DeleteProductRequest!) {
  deleteProduct(input: $input) {
    failResults {
      systemCode
      message
    }
  }
}
Variables
{"input": DeleteProductRequest}
Response
{
  "data": {
    "deleteProduct": {
      "failResults": [DeleteProductFailure]
    }
  }
}
Mutations

detachCouponProduct

Description

クーポン対象商品削除API

Response

Returns a DetachCouponProductResponse!

Arguments
Name Description
input - DetachCouponProductRequest!

Example

Query
mutation detachCouponProduct($input: DetachCouponProductRequest!) {
  detachCouponProduct(input: $input) {
    results {
      code
      status
      errorMessage
    }
  }
}
Variables
{"input": DetachCouponProductRequest}
Response
{
  "data": {
    "detachCouponProduct": {
      "results": [DetachCouponProductResult]
    }
  }
}
Mutations

shopFrontUpdateMember

Description

会員情報更新（ショップフロント）

Response

Returns a Void

Arguments
Name Description
input - ShopFrontUpdateMemberRequest!

Example

Query
mutation shopFrontUpdateMember($input: ShopFrontUpdateMemberRequest!) {
  shopFrontUpdateMember(input: $input)
}
Variables
{"input": ShopFrontUpdateMemberRequest}
Response
{"data": {"shopFrontUpdateMember": null}}
Mutations

updateAccessBodyTag

Description

アクセス解析タグ(bodyタグ)更新

Response

Returns an UpdateAccessTagResponse!

Arguments
Name Description
input - UpdateAccessTagRequest!

Example

Query
mutation updateAccessBodyTag($input: UpdateAccessTagRequest!) {
  updateAccessBodyTag(input: $input) {
    accessTag {
      tag
      key
    }
  }
}
Variables
{"input": UpdateAccessTagRequest}
Response
{
  "data": {
    "updateAccessBodyTag": {"accessTag": AccessTag}
  }
}
Mutations

updateAccessHeadTag

Description

アクセス解析タグ(headタグ)更新

Response

Returns an UpdateAccessTagResponse!

Arguments
Name Description
input - UpdateAccessTagRequest!

Example

Query
mutation updateAccessHeadTag($input: UpdateAccessTagRequest!) {
  updateAccessHeadTag(input: $input) {
    accessTag {
      tag
      key
    }
  }
}
Variables
{"input": UpdateAccessTagRequest}
Response
{
  "data": {
    "updateAccessHeadTag": {"accessTag": AccessTag}
  }
}
Mutations

updateAppChargeReservation

Description

自由決済予約更新

Response

Returns an AppChargeReservation!

Arguments
Name Description
input - UpdateAppChargeReservationRequest!

Example

Query
mutation updateAppChargeReservation($input: UpdateAppChargeReservationRequest!) {
  updateAppChargeReservation(input: $input) {
    appChargeReservationId
    reservationDate
    name
    status
    totalPrice
    totalTaxedPrice
    details {
      appChargeReservationDetailId
      name
      price
      taxRate
      taxedPrice
    }
  }
}
Variables
{"input": UpdateAppChargeReservationRequest}
Response
{
  "data": {
    "updateAppChargeReservation": {
      "appChargeReservationId": 867,
      "reservationDate": "2023-07-01",
      "name": "アプリ内課金",
      "status": "UNPROCESSED",
      "totalPrice": 10000,
      "totalTaxedPrice": 11000,
      "details": [AppChargeReservationDetail]
    }
  }
}
Mutations

updateAppChargeReservationDetail

Description

自由決済予約明細更新

Response

Returns an AppChargeReservationDetail!

Arguments
Name Description
input - UpdateAppChargeReservationDetailRequest!

Example

Query
mutation updateAppChargeReservationDetail($input: UpdateAppChargeReservationDetailRequest!) {
  updateAppChargeReservationDetail(input: $input) {
    appChargeReservationDetailId
    name
    price
    taxRate
    taxedPrice
  }
}
Variables
{"input": UpdateAppChargeReservationDetailRequest}
Response
{
  "data": {
    "updateAppChargeReservationDetail": {
      "appChargeReservationDetailId": 1,
      "name": "アイテム購入",
      "price": 1000,
      "taxRate": 10,
      "taxedPrice": 1100
    }
  }
}
Mutations

updateCoupon

Description

クーポン更新API

Response

Returns an UpdateCouponResponse!

Arguments
Name Description
input - UpdateCouponRequest!

Example

Query
mutation updateCoupon($input: UpdateCouponRequest!) {
  updateCoupon(input: $input) {
    results {
      code
      name
      status
      errorMessage
    }
  }
}
Variables
{"input": UpdateCouponRequest}
Response
{
  "data": {
    "updateCoupon": {"results": [UpdateCouponResult]}
  }
}
Mutations

updateMember

Description

会員情報更新

Response

Returns an UpdateMemberResponse!

Arguments
Name Description
input - UpdateMemberRequest!

Example

Query
mutation updateMember($input: UpdateMemberRequest!) {
  updateMember(input: $input) {
    results {
      index
      memberId
      message
    }
  }
}
Variables
{"input": UpdateMemberRequest}
Response
{
  "data": {
    "updateMember": {"results": [SaveMemberResult]}
  }
}
Mutations

updateMemberPassword

Description

会員パスワード更新

Response

Returns an UpdateMemberPasswordResponse!

Arguments
Name Description
input - UpdateMemberPasswordRequest!

Example

Query
mutation updateMemberPassword($input: UpdateMemberPasswordRequest!) {
  updateMemberPassword(input: $input) {
    results {
      index
      memberId
      message
    }
  }
}
Variables
{"input": UpdateMemberPasswordRequest}
Response
{
  "data": {
    "updateMemberPassword": {
      "results": [SaveMemberPasswordResult]
    }
  }
}
Mutations

updateMemberShopPoint

Description

会員ポイント更新

Response

Returns an UpdateMemberShopPointResponse!

Arguments
Name Description
input - UpdateMemberShopPointRequest!

Example

Query
mutation updateMemberShopPoint($input: UpdateMemberShopPointRequest!) {
  updateMemberShopPoint(input: $input) {
    results {
      index
      memberId
      shopPoint {
        point
        expireDate
        comment
      }
      message
    }
  }
}
Variables
{"input": UpdateMemberShopPointRequest}
Response
{
  "data": {
    "updateMemberShopPoint": {
      "results": [SaveMemberShopPointResult]
    }
  }
}
Mutations

updateOrderAttribute

Description

注文属性情報変更

Response

Returns an UpdateOrderAttributeResponse!

Arguments
Name Description
input - UpdateOrderAttributeRequest!

Example

Query
mutation updateOrderAttribute($input: UpdateOrderAttributeRequest!) {
  updateOrderAttribute(input: $input) {
    updateOrderAttributeResults {
      displayOrderNumber
      message
    }
  }
}
Variables
{"input": UpdateOrderAttributeRequest}
Response
{
  "data": {
    "updateOrderAttribute": {
      "updateOrderAttributeResults": [
        UpdateOrderAttributeResult
      ]
    }
  }
}
Mutations

updateOrderDeliveryStatus

Description

配送ステータス変更

Response

Returns an UpdateOrderDeliveryStatusResponse!

Arguments
Name Description
input - UpdateOrderDeliveryStatusRequest!

Example

Query
mutation updateOrderDeliveryStatus($input: UpdateOrderDeliveryStatusRequest!) {
  updateOrderDeliveryStatus(input: $input) {
    updateOrderDeliveryStatusResults {
      displayOrderNumber
      deliveryId
      message
    }
  }
}
Variables
{"input": UpdateOrderDeliveryStatusRequest}
Response
{
  "data": {
    "updateOrderDeliveryStatus": {
      "updateOrderDeliveryStatusResults": [
        UpdateOrderDeliveryStatusResult
      ]
    }
  }
}
Mutations

updateProduct

Description

商品情報更新

Response

Returns an UpdateProductResponse!

Arguments
Name Description
input - UpdateProductRequest!

Example

Query
mutation updateProduct($input: UpdateProductRequest!) {
  updateProduct(input: $input) {
    results {
      index
      systemCode
      message
    }
  }
}
Variables
{"input": UpdateProductRequest}
Response
{
  "data": {
    "updateProduct": {"results": [SaveProductResult]}
  }
}
Mutations

updateProductQuantity

Description

商品在庫情報更新

Response

Returns an UpdateProductQuantityResponse!

Arguments
Name Description
input - UpdateProductQuantityRequest!

Example

Query
mutation updateProductQuantity($input: UpdateProductQuantityRequest!) {
  updateProductQuantity(input: $input) {
    failResult {
      systemCode
      message
    }
  }
}
Variables
{"input": UpdateProductQuantityRequest}
Response
{
  "data": {
    "updateProductQuantity": {
      "failResult": [UpdateProductQuantityFailure]
    }
  }
}
Mutations

updateVariationQuantity

Description

バリエーション在庫情報更新

Response

Returns an UpdateVariationQuantityResponse!

Arguments
Name Description
input - UpdateVariationQuantityRequest!

Example

Query
mutation updateVariationQuantity($input: UpdateVariationQuantityRequest!) {
  updateVariationQuantity(input: $input) {
    failResult {
      systemCode
      variation1ItemId
      variation2ItemId
      message
    }
  }
}
Variables
{"input": UpdateVariationQuantityRequest}
Response
{
  "data": {
    "updateVariationQuantity": {
      "failResult": [UpdateVariationQuantityFailure]
    }
  }
}

Types

AccessTag

Description

アクセス解析タグ

Fields
Field Name Description
tag - String! アクセス解析タグ
key - String! タグを識別するためのキー
Example
{"tag": "<script src=\"javascript.js\"></script>", "key": "access_tag_key"}
Types

AppChargeReservation

Description

自由決済予約

Fields
Field Name Description
appChargeReservationId - Int64! 決済予約ID
reservationDate - String! 決済日
name - String! 決済予約名
アプリ側での決済予約管理用
※ショップ管理画面には表示されません
※ショップ様への通知メールに記載されます
status - PaymentStatus! ステータス
totalPrice - Uint64! 税抜支払総額
totalTaxedPrice - Uint64! 税込支払総額
details - [AppChargeReservationDetail!]! 決済予約明細一覧
Example
{
  "appChargeReservationId": 867,
  "reservationDate": "2023-07-01",
  "name": "アプリ内課金",
  "status": "UNPROCESSED",
  "totalPrice": 10000,
  "totalTaxedPrice": 11000,
  "details": [AppChargeReservationDetail]
}
Types

AppChargeReservationDetail

Description

自由決済予約明細

Fields
Field Name Description
appChargeReservationDetailId - Int64! 決済予約明細ID
name - String! 決済名目
※登録した決済名目は、 管理画面）アプリ管理 > アプリ決済情報 に表示されます
price - Uint64! 税抜支払額
taxRate - Uint64! 税率
taxedPrice - Uint64! 税込支払額
Example
{
  "appChargeReservationDetailId": 1,
  "name": "アイテム購入",
  "price": 1000,
  "taxRate": 10,
  "taxedPrice": 1100
}
Types

AppSubscriptionSettlementStatus

Description

アプリサブスクリプション決済ステータス

Values
Enum Value Description

OK

 正常

RETRYING

 再決済中

NG

 異常
Example
"OK"
Types

AppSubscriptionStatus

Description

アプリサブスクリプションステータス

Values
Enum Value Description

IN_USE

利用中

  • サブスクリプションを利用している状態

CANCELED

キャンセル

  • サブスクリプションの自動更新がキャンセルされた状態
  • トライアル期間内または有効期限内であれば利用可能

END_OF_USE

利用終了

  • キャンセル後、トライアル期間または有効期限が切れた状態
Example
"IN_USE"
Types

Area

Description

エリア情報

Fields
Field Name Description
areaName - String エリア名
zipCodes - [String] 郵便番号
Example
{"areaName": "北海道離島", "zipCodes": ["0431401,0431402,0431403"]}
Types

AttachCouponProduct

Fields
Input Field Description
code - String! クーポンコード
productCodes - [String!]! 対象商品コード
Example
{"code": "coupon", "productCodes": ["123456789"]}
Types

AttachCouponProductRequest

Description

クーポン対象商品登録リクエスト

Fields
Input Field Description
couponProducts - [AttachCouponProduct]!
Example
{"couponProducts": [AttachCouponProduct]}
Types

AttachCouponProductResponse

Description

対象商品登録レスポンス

Fields
Field Name Description
results - [AttachCouponProductResult!]
Example
{"results": [AttachCouponProductResult]}
Types

AttachCouponProductResult

Fields
Field Name Description
code - String クーポンコード
status - AttachCouponProductResultStatus!

結果ステータス

  • SUCCESS：成功
  • FAIL：失敗
errorMessage - String エラーメッセージ
※失敗した場合のみ設定されます
Example
{"code": "coupon", "status": "SUCCESS", "errorMessage": "エラーメッセージ"}
Types

AttachCouponProductResultStatus

Description

結果ステータス

Values
Enum Value Description

SUCCESS

 成功

FAIL

 失敗
Example
"SUCCESS"
Types

BasketInfo

Description

商品情報

Fields
Field Name Description
productCode - String! システム商品コード
productCustomCode - String 独自商品コード
variationCustomCode - String バリエーション独自コード
productName - String 商品名
variationName - String! バリエーション情報

バリエーションおよびオプショングループの選択項目
variation1ItemId - Int64 バリエーション1項目ID
variation2ItemId - Int64 バリエーション2項目ID
optionCode - String オプショングループコード
addcode - String 商品別特殊表示
amount - Int64 商品数量
price - Int64 商品価格
taxRate - Uint64! 税率
grantedShopPoint - Int64 商品ポイント
addToCartDate - String 買い物かごへの登録日時
discountRate - String 割引率
Example
{
  "productCode": "000000000001",
  "productCustomCode": "itemcode01",
  "variationCustomCode": "optioncode01",
  "productName": "テスト商品1",
  "variationName": "サイズ : S",
  "variation1ItemId": 1,
  "variation2ItemId": 0,
  "optionCode": "[SP1010]",
  "addcode": "商品別特殊表示",
  "amount": 1,
  "price": 1000,
  "taxRate": 10,
  "grantedShopPoint": 10,
  "addToCartDate": "20230524",
  "discountRate": "0"
}
Types

BasketInfoForProduct

Description

販売情報

Fields
Input Field Description
sellPrice - Int64 販売価格 （商品情報登録時は指定必須）
taxRate - Uint64 税率
consumerPrice - Uint64 定価
buyPrice - Int64 仕入価格
deliveryRegdate - String 配送方法
Example
{
  "sellPrice": 999999999,
  "taxRate": 10,
  "consumerPrice": 999999999,
  "buyPrice": 999999999,
  "deliveryRegdate": "20240301140233"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

CancelOrder

Fields
Input Field Description
displayOrderNumber - String! 注文番号
deliveryId - String 配送先ID

※ギフト配送注文かつ配送先単位でキャンセルしたい場合のみ指定してください。
※ギフト配送注文の場合に指定されない場合、注文単位でのキャンセル（ギフト配送先が全てキャンセル）となります。
isReturnStock - Boolean

在庫戻しを実施するか

  • true : 実施する
  • false : 実施しない

※未設定時はfalseとして扱われます。
isReturnPoint - Boolean

利用・付与ポイントを返還するか

  • true : 返還する
  • false : 返還しない

※未設定時はfalseとして扱われます。
Example
{
  "displayOrderNumber": "P170000000000000000",
  "deliveryId": "01",
  "isReturnStock": false,
  "isReturnPoint": false
}
Types

CancelOrderRequest

Description

注文キャンセルリクエスト

Fields
Input Field Description
cancelOrderRequests - [CancelOrder]
Example
{"cancelOrderRequests": [CancelOrder]}
Types

CancelOrderResponse

Description

注文キャンセルレスポンス

Fields
Field Name Description
cancelOrderResults - [CancelOrderResult]
Example
{"cancelOrderResults": [CancelOrderResult]}
Types

CancelOrderResult

Description

注文キャンセルの結果情報

Fields
Field Name Description
displayOrderNumber - String 注文番号
deliveryId - String 配送先ID
※ギフト配送の注文かつ配送先単位でキャンセルした場合のみ値が返ります。
message - String エラーメッセージ
※注文キャンセルに失敗した場合のみ値が返ります。
Example
{
  "displayOrderNumber": "P170000000000000000",
  "deliveryId": "01",
  "message": "既にキャンセル済みの注文です"
}
Types

CashOnDelivery

Description

代金引換

Fields
Field Name Description
settingCashOnDelivery - String

代金引換の利用設定

  • Y：利用する
  • N：利用しない
settingCashOnDeliveryMemberFee - String

代金引換の会員手数料設定

  • Y：無料
  • N：有料
cashOnDeliveryPaymentAmountLimit - String 代金引換の決済金額上限額
settingCashOnDeliveryFeeMethod - String

代金引換の手数料計算方法

  • Y：配送料+注文金額の合計
  • N：注文金額の合計
settingCashOnDeliveryFees - [SettingCashOnDeliveryFee]

代金引換の手数料設定

  • 代金引換手数料を購入者に負担していただく場合の手数料設定
settingMemberGroupCashOnDeliveryFees - [SettingMemberGroupCashOnDeliveryFee] 会員グループ別の代金引換手数料設定
Example
{
  "settingCashOnDelivery": "Y",
  "settingCashOnDeliveryMemberFee": "N",
  "cashOnDeliveryPaymentAmountLimit": "300000",
  "settingCashOnDeliveryFeeMethod": "Y",
  "settingCashOnDeliveryFees": [SettingCashOnDeliveryFee],
  "settingMemberGroupCashOnDeliveryFees": [
    SettingMemberGroupCashOnDeliveryFee
  ]
}
Types

Category

Description

商品カテゴリ情報の明細データ

Fields
Field Name Description
categoryUID - Uint64 カテゴリUID
isMainCategory - String 商品メインカテゴリーフラグ
categoryImage - String

カテゴリ別イメージ有無

  • Y: あり
categoryName - String カテゴリ名
categoryTitle - String メタタグのタイトル
productDisplayType - String 商品陳列デザイン
productDetailType - String 商品詳細デザイン
isMembersOnly - String

会員専用可否

  • Y: 会員専用
  • N: 会員非専用
categorySort - String

カテゴリ名のソート順

2000＋ソート順."-00-00 00:00:00"
productBaseSortType - String

商品基本整列方法

  • order: 商品登録/修正日付順
  • brandname: 商品名順
  • product: 製造元順
  • price: 価格順
  • recommend: おすすめ順
estimateListOrder - Int64

見積書リスト順

999の場合は見積書リストに非表示
seoContents - String

SEO設定

以下の内容を｜で連結

  • ブラウザタイトル
  • メタタグKeyword
  • メタタグDescription
  • メタタグAuthor
  • ボディタグ直下メッセージ
accessGroup - String

会員グループID

アクセスを許可するグループコードを:区切りで連結。 IDが一つ以上ある場合、必ず最後に:が付与される。
isPcCategoryDisplay - String

PCカテゴリ一覧への表示可否

  • Y: 表示する
  • N: 表示しない
isMobileCategoryDisplay - String

スマートフォンカテゴリ一覧への表示

  • Y: 表示する
  • N: 表示しない
categoryDepth - String

カテゴリ階層

  • 1: 第1階層
  • 2: 第2階層
  • 3: 第3階層
  • 4: 第4階層
  • 5: 第5階層
category1 - Uint64

第1階層カテゴリ

第1階層のcategory_uid
category2 - Uint64

第2階層カテゴリ

第2階層のcategory_uid
category3 - Uint64

第3階層カテゴリ

第3階層のcategory_uid
category4 - Uint64

第4階層カテゴリ

第4階層のcategory_uid
category5 - Uint64

第5階層カテゴリ

第5階層のcategory_uid
categoryCode - String 任意の識別コード
categoryUrl - String 商品カテゴリー画面URLのパラメータ
categories - [Category] 商品カテゴリ情報
Example
{
  "categoryUID": 5,
  "isMainCategory": "Y",
  "categoryImage": "Y",
  "categoryName": "テストカテゴリー",
  "categoryTitle": "カテゴリーページタイトル",
  "productDisplayType": "Z",
  "productDetailType": "Z",
  "isMembersOnly": "N",
  "categorySort": null,
  "productBaseSortType": "order",
  "estimateListOrder": 999,
  "seoContents": "テストカテゴリー　ブラウザータイトル||テストカテゴリー　Description||テストカテゴリー　ボディタグ直下メッセージ",
  "accessGroup": "RP0001:RP0002:",
  "isPcCategoryDisplay": "Y",
  "isMobileCategoryDisplay": "Y",
  "categoryDepth": "1",
  "category1": 5,
  "category2": 0,
  "category3": 0,
  "category4": 0,
  "category5": 0,
  "categoryCode": "ct5",
  "categoryUrl": "ct5",
  "categories": [Category]
}
Types

CompanyOverview

Description

会社概要ページの表示設定

Fields
Field Name Description
pcText - String

PC表示用：テキスト

PC用ショップの会社概要ページに表示されるテキスト。
spText - String

スマホ表示用：テキスト

スマホ用ショップの会社概要ページに表示されるテキスト。
Example
{"pcText": "会社名：株式会社○○\n代表者：メイク 太郎", "spText": "会社名：株式会社○○\n代表者：メイク 太郎"}
Types

CompanyType

Description

事業形態

Values
Enum Value Description

PERSONAL

 個人

COMPANY

 法人
Example
"PERSONAL"
Types

Contact

Description

お問い合わせ先設定

Fields
Field Name Description
mailAddress - String

お問い合わせ先メールアドレス

お客様からのお問合せを頂くメールアドレス
tel - String

お問い合わせ先電話番号

ショップ左下に表示されるお問い合わせ先電話番号。 複数表示する場合はカンマ（、）で区切って入力する。
address - String

お問い合わせ先所在地

ページのフッター（下段部）に表示される住所。
fromName - String

送信元名称

以下の自動返信メールのFrom欄に表示される名称。

ビジター注文確認 リピーター注文確認 注文確認メール再送用 先入金確認 後入金確認 配送完了
orderMailAddressList - [String]

注文メールアドレスリスト

注文があった際に配信される自動返信メール（ビジター・リピーター注文確認）のメールアドレス。 問合せと注文を別のメールアドレスで管理したい場合に使用する。
stockAlarmMailAddressList - [String]

在庫アラームメールアドレスリスト

在庫数が「在庫管理」にて設定した数以下となった場合に、配信されるメール（在庫アラームメール）を受け取るメールアドレス。
stockManagementSystemOrderMailAddress - String 在庫管理システム用注文メールアドレス
Example
{
  "mailAddress": "info@example.com",
  "tel": "03-0000-0000",
  "address": "東京都渋谷区○○",
  "fromName": "○○ショップ",
  "orderMailAddressList": ["info2@example.com"],
  "stockAlarmMailAddressList": ["info3@example.com"],
  "stockManagementSystemOrderMailAddress": "info4@example.com"
}
Types

CouponInfo

Description

クーポン情報

Fields
Field Name Description
couponName - String クーポン名
(2024.03.25追加)
couponCode - String クーポンコード
(2024.03.25追加)
couponDiscount - Int64 クーポン割引額
(2024.03.25追加)
Example
{
  "couponName": "1万円以上で500円引き",
  "couponCode": "j6jze4t9n8gzmghxnk40",
  "couponDiscount": "-500"
}
Types

CouponOrderBy

Description

クーポンソートカラム

Values
Enum Value Description

UPDATED_AT

 更新日時

STARTED_AT

 開始日時

ENDED_AT

 終了日時
Example
"UPDATED_AT"
Types

CreateAccessTagRequest

Description

アクセス解析タグ登録リクエスト

Fields
Input Field Description
tag - String!

アクセス解析タグ 使用可能タグ

  • [MEMBER_ID]：会員ID
key - String!

タグを識別するためのキー

許容文字: 英数字とアンダースコア, 下限: 1文字, 上限: 32文字
Example
{"tag": "<script src=\"javascript.js\"></script>", "key": "Access_tag_key01"}
Types

CreateAccessTagResponse

Description

アクセス解析タグ登録レスポンス

Fields
Field Name Description
accessTag - AccessTag! アクセス解析タグ
Example
{"accessTag": AccessTag}
Types

CreateAppChargeReservationDetailRequest

Description

自由決済予約明細登録リクエスト

Fields
Input Field Description
appChargeReservationId - Int64! 決済予約ID
name - String! 決済名目
※登録した決済名目は、 管理画面）アプリ管理 > アプリ決済情報 に表示されます
price - Uint64! 税抜支払額
taxRate - Uint64! 税率
taxedPrice - Uint64! 税込支払額
Example
{
  "appChargeReservationId": 867,
  "name": "アイテム購入",
  "price": 1000,
  "taxRate": 10,
  "taxedPrice": 1100
}
Types

CreateAppChargeReservationRequest

Description

自由決済予約登録リクエスト

Fields
Input Field Description
reservationDate - String!

決済日

  • 決済タイミングは指定した決済日の00:10
  • 翌日から1年後まで予約可能
    例）2024/6/1にリクエストする場合、2024/6/2から2025/6/1まで指定可能
name - String! 決済予約名
アプリ側での決済予約管理用
※ショップ管理画面には表示されません
※ショップ様への通知メールに記載されます
Example
{"reservationDate": "2023-07-01", "name": "アプリ内課金"}
Types

CreateCoupon

Fields
Input Field Description
code - String

クーポンコード

※codeAutoCreate = false の場合、必須
codeAutoCreate - Boolean

クーポンコード自動生成フラグ

  • true: 自動生成

※デフォルト: false. Default = false
name - String! クーポン名
isEnabled - Boolean

状態

  • true：有効
  • false：無効

※デフォルト: false. Default = false
isForOnlyMember - Boolean

会員専用フラグ

  • true：会員専用
  • false：誰でも

※デフォルト: false. Default = false
hasMaximumMemberUsableCount - Boolean

利用回数上限設定フラグ

  • false：無制限
  • true: 利用回数上限あり

※デフォルト: false。isForOnlyMember = true の時、設定可能。. Default = false
maximumMemberUsableCount - Uint64

利用回数上限

※hasMaximumMemberUsableCount = true の場合、必須
hasMemberGroupIds - Boolean

利用可能会員グループ設定フラグ

  • true: 指定したグループ会員のみ
  • false：会員なら誰でも

※デフォルト: false. Default = false
memberGroupIds - [Int64!]

利用可能な会員グループID

  • [xxx]: xxx グループの会員のみ

※hasMemberGroupIds = true の時、必須。IsForOnlyMember = true の時、必須。最大：50件. Default = null
hasMinimumPrice - Boolean

最低利用金額設定フラグ

  • true：制限あり
  • false：最低利用金額なし

※デフォルト: false. Default = false
minimumPrice - Uint64

最低利用金額

※hasMinumumPrice = true の場合、必須
hasTotalUseCount - Boolean

発行数設定フラグ

  • true：発行数
  • false：発行数無限

※デフォルト: false. Default = false
totalUseCount - Uint64

発行数

※hasTotalUseCount = true の場合、必須
isTargetProduct - Boolean

対象商品設定フラグ

  • true：対象商品を指定
  • false：すべて

※デフォルト: false. Default = false
discountType - DiscountType!

割引タイプ

  • FIXED_AMOUNT：定額
  • FIXED_RATE：定率
  • FREE_DELIVERY_FEE：送料無料
fixedAmount - Uint64

定額

※「定額」の場合、必須
fixedRate - Uint64

定率

※「定率」の場合、必須
hasPeriod - Boolean

期間設定フラグ

  • true: 期間設定あり
  • false：期間設定なし

※デフォルト: false. Default = false
startedAt - String

利用開始日時

※hasPeriod = true の場合、必須
endedAt - String

利用終了日時

※hasPeriod = true の場合、必須
Example
{
  "code": "coupon",
  "codeAutoCreate": false,
  "name": "クーポン",
  "isEnabled": false,
  "isForOnlyMember": false,
  "hasMaximumMemberUsableCount": false,
  "maximumMemberUsableCount": 100,
  "hasMemberGroupIds": false,
  "memberGroupIds": [10, 20],
  "hasMinimumPrice": false,
  "minimumPrice": 100,
  "hasTotalUseCount": false,
  "totalUseCount": 100,
  "isTargetProduct": false,
  "discountType": "FIXED_AMOUNT",
  "fixedAmount": 100,
  "fixedRate": 10,
  "hasPeriod": false,
  "startedAt": "2006-01-02 15:04:05",
  "endedAt": "2006-01-02 15:04:05"
}
Types

CreateCouponRequest

Description

クーポン登録リクエスト

Fields
Input Field Description
coupons - [CreateCoupon]!
Example
{"coupons": [CreateCoupon]}
Types

CreateCouponResponse

Description

クーポン登録レスポンス

Fields
Field Name Description
results - [CreateCouponResult!]
Example
{"results": [CreateCouponResult]}
Types

CreateCouponResult

Fields
Field Name Description
code - String クーポンコード
name - String! クーポン名
status - CreateCouponResultStatus!

結果ステータス

  • SUCCESS：成功
  • FAIL：失敗
errorMessage - String

エラーメッセージ

※失敗した場合のみ設定されます
Example
{
  "code": "coupon",
  "name": "クーポン",
  "status": "SUCCESS",
  "errorMessage": "エラーメッセージ"
}
Types

CreateCouponResultStatus

Description

結果ステータス

Values
Enum Value Description

SUCCESS

 成功

FAIL

 失敗
Example
"SUCCESS"
Types

CreateMember

Fields
Input Field Description
groupId - String 会員グループID
memberId - String 会員ID
システムで予約されているため大文字のXから始まる会員IDは利用できません
password - String! パスワード
※半角英数字4文字以上32文字以内で指定してください
name - String 会員名
nameKana - String 会員名（カナ）
email - String メールアドレス
mailMagazineFlag - String

メールマガジン受信可否

  • Y：希望する
  • N：希望しない
sex - String

性別

  • 0：男性
  • 1：女性
  • 2：無回答
birthday - String

生年月日

  • YYYYMMDD形式
recommandMemberId - String 紹介者ID
hpost - String 郵便番号(自宅)
haddress1 - String 都道府県コード(自宅)
haddress2 - String 市区町村(自宅)
haddress - String その他住所等(自宅)
tel - String 電話番号(自宅) ※ハイフンあり
fax - String FAX番号(自宅) ※ハイフンあり
etcphone - String 電話番号(携帯) ※ハイフンあり
hpEmail - String メールアドレス(携帯)
officename - String 会社名
※BtoBオプション機能のご契約のショップ様のみ有効です
officenameKana - String 会社名(カナ)
※BtoBオプション機能のご契約のショップ様のみ有効です
officedept - String 所属部署名
※BtoBオプション機能のご契約のショップ様のみ有効です
opost - String 郵便番号(会社)
oaddress1 - String 都道府県コード(会社)
oaddress - String 市区町村(会社)
ophone - String 電話番号(会社) ※ハイフンあり
etc - [String] 追加入力項目
※各項目の値に|は使用できません
※項目数や各項目の設定の詳細はショップ様により異なるため、getShopにてご確認ください
joinDate - String

登録日

  • YYYYMMDD形式
memberIdAutoCreate - String

会員ID自動採番設定

  • Y：会員IDを自動で採番する
  • N：入力した会員IDを利用する
loginEmailAuth - String

メールアドレスログイン可否

  • Y：ログイン可
  • N：ログイン不可


※会員のログイン許可設定で、メールアドレスでのログインを許可している場合のみ有効です
adminMemberAuth - String

管理者による会員認証

  • Y：会員登録後すぐに会員のログインを許可する
  • N：会員登録後すぐに会員のログインを許可しない
Example
{
  "groupId": "1",
  "memberId": "usertest",
  "password": "fc4890a7",
  "name": "メイク太郎",
  "nameKana": "メイクタロウ",
  "email": "test@mail.com",
  "mailMagazineFlag": "Y",
  "sex": "0",
  "birthday": "19750516",
  "recommandMemberId": "rectest",
  "hpost": "1508512",
  "haddress1": "13",
  "haddress2": "渋谷区",
  "haddress": "渋谷1-1-1",
  "tel": "03-1234-5678",
  "fax": "03-1234-5678",
  "etcphone": "090-1234-5678",
  "hpEmail": "test@mail.com",
  "officename": "サンプル会社",
  "officenameKana": "サンプルガイシャ",
  "officedept": "開発部",
  "opost": "1508512",
  "oaddress1": "13",
  "oaddress": "渋谷区",
  "ophone": "03-1234-5678",
  "etc": ["[友人からの紹介,月に１回]"],
  "joinDate": "20230601123000",
  "memberIdAutoCreate": true,
  "loginEmailAuth": "Y",
  "adminMemberAuth": true
}
Types

CreateMemberRequest

Description

会員登録リクエスト

Fields
Input Field Description
members - [CreateMember]!
Example
{"members": [CreateMember]}
Types

CreateMemberResponse

Description

会員登録レスポンス

Fields
Field Name Description
results - [CreateMemberResult!]
Example
{"results": [CreateMemberResult]}
Types

CreateMemberResult

Description

会員情報作成の結果情報

Fields
Field Name Description
status - CreateMemberResultStatus!

結果ステータス

  • SUCCESS：成功
  • FAIL：失敗
memberId - String 会員ID
errorMessage - String エラーメッセージ
※失敗した場合のみ設定されます
Example
{"status": "SUCCESS", "memberId": "000000000001", "errorMessage": "エラーメッセージ"}
Types

CreateMemberResultStatus

Description

結果ステータス

Values
Enum Value Description

SUCCESS

 成功

FAIL

 失敗
Example
"SUCCESS"
Types

CreateOrderRequest

Fields
Input Field Description
orderRequests - [OrderRequest] 注文リクエスト
Example
{"orderRequests": [OrderRequest]}
Types

CreateOrderResponse

Description

注文情報登録レスポンス

Fields
Field Name Description
orderResults - [OrderResult]
Example
{"orderResults": [OrderResult]}
Types

CreateOrderResult

Description

結果ステータス

Values
Enum Value Description

SUCCESS

 成功

FAIL

 失敗

ACTION_REQUIRED

 注文処理を継続するのに追加の操作が必要（3Dセキュア等）
Example
"SUCCESS"
Types

CreateProduct

Description

商品情報登録のリクエスト詳細

Fields
Input Field Description
productBasicInfo - ProductBasicInfo 基本情報
basketInfo - BasketInfoForProduct 販売情報
stockInfo - StockInfo 数量情報
imageInfo - ImageInfo 画像情報
variationInfo - VariationInfo バリエーション情報
viewInfo - ViewInfo 表示情報
detailInfo - DetailInfo 詳細情報
promotionInfo - PromotionInfo 販促情報
seoInfo - SeoInfo SEO情報
enhancement - Enhancement 追加機能
optionalFeature - OptionalFeature オプション機能
Example
{
  "productBasicInfo": ProductBasicInfo,
  "basketInfo": BasketInfoForProduct,
  "stockInfo": StockInfo,
  "imageInfo": ImageInfo,
  "variationInfo": VariationInfo,
  "viewInfo": ViewInfo,
  "detailInfo": DetailInfo,
  "promotionInfo": PromotionInfo,
  "seoInfo": SeoInfo,
  "enhancement": Enhancement,
  "optionalFeature": OptionalFeature
}
Types

CreateProductRequest

Description

商品情報登録のリクエスト

Fields
Input Field Description
products - [CreateProduct!]!
Example
{"products": [CreateProduct]}
Types

CreateProductResponse

Description

商品情報登録のレスポンス

Fields
Field Name Description
results - [SaveProductResult!]
Example
{"results": [SaveProductResult]}
Types

CustomerInfo

Description

注文者情報

Fields
Input Field Description
name - String! 注文者の名前
nameKana - String! 注文者の名前（カナ）
officeName - String 注文者の会社名
officeNameKana - String 注文者の会社名（カナ）
department - String 注文者の部署名
email - String! 注文者のメールアドレス
post - String! 注文者の郵便番号
※ハイフンなしで指定してください。
prefectureCode - Int64! 注文者の都道府県コード
address - String! 注文者の市区町村
address2 - String! 注文者の以降の住所
telephone - String! 注文者の電話番号
※ハイフンありで指定してください。
otherMessage - String 注文者からの連絡事項
Example
{
  "name": "⼭⽥ 太郎",
  "nameKana": "ヤマダ タロウ",
  "officeName": "サンプル会社",
  "officeNameKana": "サンプルガイシャ",
  "department": "サンプル部",
  "email": "info@example.jp",
  "post": "1508512",
  "prefectureCode": 13,
  "address": "渋⾕区",
  "address2": "桜丘町",
  "telephone": "00-0000-0000",
  "otherMessage": "ギフトラッピング希望"
}
Types

CustomerInfoForUpdate

Description

注文者情報（更新用）

Fields
Input Field Description
name - String 注文者の名前
nameKana - String 注文者の名前（カナ）
officeName - String 注文者の会社名
※BtoBオプション機能のご契約ショップ様が対象。
officeNameKana - String 注文者の会社名（カナ）
※BtoBオプション機能のご契約ショップ様が対象。
department - String 注文者の部署名
※BtoBオプション機能のご契約ショップ様が対象。
email - String 注文者のメールアドレス
post - String 注文者の郵便番号
※ハイフンなしで指定してください。
prefectureCode - Int64 注文者の都道府県コード
address - String 注文者の市区町村
address2 - String 注文者の以降の住所
telephone - String 注文者の電話番号
※ハイフンありで指定してください。
memberFlag - Boolean

会員フラグ（ブラックリストフラグ）

  • true : 設定する
  • false : 設定しない


※未設定時はfalseとして扱われます。
Example
{
  "name": "⼭⽥ 太郎",
  "nameKana": "ヤマダ タロウ",
  "officeName": "サンプル会社",
  "officeNameKana": "サンプルガイシャ",
  "department": "サンプル部",
  "email": "info@example.jp",
  "post": "1508512",
  "prefectureCode": 13,
  "address": "渋⾕区",
  "address2": "桜丘町",
  "telephone": "00-0000-0000",
  "memberFlag": false
}
Types

CycleDesignate

Description

定期購入商品情報取得　お届けサイクル指定方法を示すENUM値

Values
Enum Value Description

USER

 購入者が指定

SHOP

 ショップが指定
Example
"USER"
Types

CycleDetail

Description

サイクル情報の明細データ

Fields
Field Name Description
cycleId - String お届けサイクルID
cycleName - String お届けサイクル名
cycleDesignate - String

お届けサイクル指定方法

  • USER: 購入者が指定
  • SHOP: ショップが指定
userDesignateSetting - UserDesignateSetting お届けサイクル情報（購入者が指定）
shopDesignateSetting - ShopDesignateSetting お届けサイクル情報（ショップが指定）
Example
{
  "cycleId": "20230524162437",
  "cycleName": "毎月1日にお届け",
  "cycleDesignate": "SHOP",
  "userDesignateSetting": UserDesignateSetting,
  "shopDesignateSetting": ShopDesignateSetting
}
Types

CycleInfo

Description

お届けサイクル情報

Fields
Input Field Description
cycleType - CycleType お届けサイクルタイプ

※お届けサイクル指定方法が「購入者が指定」の場合、入力が必須です。 「ショップが指定」の場合、入力は不要です。
cycleBaseDate - String 定期購⼊商品の初回お届け⽇
cycleDate - [Uint64!] お届けする日付
例）
[10]：毎月10日
[10,20]：毎月10日・20日
[99]：月末
cycleWeekOfMonth - Uint64 お届けする週
例）
1：毎月第1週（曜日はcycleDayOfWeekで指定）
3：毎月第3週（曜日はcycleDayOfWeekで指定）
cycleDayOfWeek - DayOfWeek お届けする曜日
cycleIntervalDays - Uint64 お届けする間隔（日）
例）
10：10日ごと
cycleIntervalMonths - Uint64 お届けする間隔（月）
例）
1：1ヶ月ごと
Example
{
  "cycleType": "DATE",
  "cycleBaseDate": "20241230",
  "cycleDate": [10, 20],
  "cycleWeekOfMonth": 1,
  "cycleDayOfWeek": "MONDAY",
  "cycleIntervalDays": 10,
  "cycleIntervalMonths": 1
}
Types

CycleType

Description

定期購入のお届けサイクル

Values
Enum Value Description

DATE

 日付指定

DAY_OF_WEEK

 曜日指定

INTERVAL

 間隔
Example
"DATE"
Types

DayOfWeek

Description

曜日指定

Values
Enum Value Description

MONDAY

 月曜

TUESDAY

 火曜

WEDNESDAY

 水曜

THURSDAY

 木曜

FRIDAY

 金曜

SATURDAY

 土曜

SUNDAY

 日曜
Example
"MONDAY"
Types

DeleteAccessTagRequest

Description

アクセス解析タグ削除リクエスト

Fields
Input Field Description
key - String!

タグを識別するためのキー

許容文字: 英数字とアンダースコア, 下限: 1文字, 上限: 32文字
Example
{"key": "Access_tag_key01"}
Types

DeleteAppChargeReservationDetailRequest

Description

自由決済予約明細削除リクエスト
※対象が未決済であれば削除可能です

Fields
Input Field Description
appChargeReservationDetailId - Int64! 決済予約ID
Example
{"appChargeReservationDetailId": 867}
Types

DeleteAppChargeReservationRequest

Description

自由決済予約削除リクエスト
※対象が未決済であれば削除可能です

Fields
Input Field Description
appChargeReservationId - Int64! 決済予約ID
Example
{"appChargeReservationId": 867}
Types

DeleteCouponRequest

Description

クーポン削除リクエスト

Fields
Input Field Description
codes - [String!]!

クーポンコードリスト

※購入アシスト経由で作成されたクーポンは削除できません。
Example
{"codes": ["coupon"]}
Types

DeleteCouponResponse

Description

クーポン削除レスポンス

Fields
Field Name Description
results - [DeleteCouponResult!]
Example
{"results": [DeleteCouponResult]}
Types

DeleteCouponResult

Description

クーポン削除レスポンス

Fields
Field Name Description
code - String クーポンコード
status - DeleteCouponResultStatus!

結果ステータス

  • SUCCESS：成功
  • FAIL：失敗
errorMessage - String

エラーメッセージ

※失敗した場合のみ設定されます
Example
{"code": "coupon", "status": "SUCCESS", "errorMessage": "エラーメッセージ"}
Types

DeleteCouponResultStatus

Description

結果ステータス

Values
Enum Value Description

SUCCESS

 成功

FAIL

 失敗
Example
"SUCCESS"
Types

DeleteMemberRequest

Description

会員情報削除のリクエスト

  • 会員情報削除API実行で一度に削除できる会員情報は1件です
  • 予約販売の注文情報が存在する会員情報は削除できません
  • 定期購入の注文情報が存在する会員情報は削除できません
  • 多店舗連携を行っているショップの会員は削除会員となります
  • 商品購入時に決済会社に保存した会員のカード情報は削除します
Fields
Input Field Description
memberId - String! 会員ID
Example
{"memberId": "230517000001"}
Types

DeleteProductFailure

Description

商品情報削除の失敗情報

Fields
Field Name Description
systemCode - String! システム商品コード
message - String! エラーメッセージ
Example
{"systemCode": "000000000001", "message": " 指定されたシステム商品コードに紐づく商品が存在しません。"}
Types

DeleteProductRequest

Description

商品情報削除のリクエスト

Fields
Input Field Description
systemCodes - [String!]! システム商品コード
Example
{"systemCodes": ["000000000001"]}
Types

DeleteProductResponse

Description

商品情報削除のレスポンス

Fields
Field Name Description
failResults - [DeleteProductFailure!]
Example
{"failResults": [DeleteProductFailure]}
Types

Delivery

Description

配送

Fields
Field Name Description
settingDeliveryMethods - [SettingDeliveryMethod] 配送方法
settingDeliveryDate - SettingDeliveryDate 配送日時
Example
{
  "settingDeliveryMethods": [SettingDeliveryMethod],
  "settingDeliveryDate": SettingDeliveryDate
}
Types

DeliveryInfo

Description

配送情報

Fields
Field Name Description
deliveryId - String! 配送先ID
※ギフト配送注文の場合のみ値が返ります
deliveryStatus - String

配送状態

  • N：未処理
  • Y：配送完了
  • C：キャンセル
  • R：返送
deliveryCompanyCode - String 配送会社コード
slipNumber - String 配送伝票番号
deliveryDate - String 配送完了日
deliveryMethodIds - String 配送方法ID（YYYYMMDDhhmmss形式）
desiredDeliveryDate - String 配送希望日
desiredDeliveryTimezone - String 配送希望時間帯
estimatedShipmentDate - Time 出荷予定日
shippingCharge - Int64 配送料金
receiverCompany - String 受取人法人名
receiverCompanyKana - String 受取人法人かな名
receiverCompanyDept - String 受取人部署名
receiverName - String 受取人名
receiverNameKana - String 受取人名（カタカナ）
receiverPost - String 受取人郵便番号
receiverPrefecture - String 受取人住所(都道府県)
receiverAddress - String 受取人住所(市区町村・番地など)
receiverAddress2 - String! 受取人住所(それ以降)
receiverTel - String 受取人電話番号
deliveryMessage - String 配送備考
wmsStatus - String!

出荷指示ステータス

  • 0：出荷未指示
  • 1：出荷準備中
  • 2：出荷指示済み
wmsChangeStatus - String!

出荷準備中に注文更新したかフラグ

  • N：変更していない
  • Y：変更した
deliverySumPrice - Int64 注文合計金額
basketInfos - [BasketInfo]! 商品情報
Example
{
  "deliveryId": "01",
  "deliveryStatus": "Y",
  "deliveryCompanyCode": "002",
  "slipNumber": "12345678912",
  "deliveryDate": "20230524173159",
  "deliveryMethodIds": "20230517170431",
  "desiredDeliveryDate": "2023-05-03",
  "desiredDeliveryTimezone": "午前中",
  "estimatedShipmentDate": "2023-05-01 00:00:00",
  "shippingCharge": 1000,
  "receiverCompany": "○○株式会社",
  "receiverCompanyKana": "○○カブシキガイシャ",
  "receiverCompanyDept": "○○部署",
  "receiverName": "メイク太郎",
  "receiverNameKana": "メイクタロウ",
  "receiverPost": "0000000",
  "receiverPrefecture": "東京都",
  "receiverAddress": "渋谷区",
  "receiverAddress2": "○○町1-1-1",
  "receiverTel": "03-0000-0000",
  "deliveryMessage": "伝達メッセージ : 決済画面 備考欄用の内容入力 || deliveryMethodFixationData | 20230517170431:1000:000000000002::[MEMO]お得意様のため○○同梱して配送予定",
  "wmsStatus": "0",
  "wmsChangeStatus": "N",
  "deliverySumPrice": 2000,
  "basketInfos": [BasketInfo]
}
Types

DeliveryRequestInfo

Description

お届け先
※指定できるお届け先は最大20件まで

Fields
Input Field Description
deliveryId - String 配送先ID
※ギフト配送注文の場合に指定
receiverName - String! お届け先の名前
receiverNameKana - String! お届け先の名前（カナ）
receiverCompany - String お届け先の会社名
receiverCompanyKana - String お届け先の会社名（カナ）
receiverCompanyDept - String お届け先の部署名
receiverPost - String! お届け先の郵便番号
※ハイフンなしで指定してください。
receiverPrefectureCode - Uint64! お届け先の都道府県コード
receiverAddress - String! お届け先の市区町村
receiverAddress2 - String! お届け先の以降の住所
receiverTel - String! お届け先の電話番号
※ハイフンありで指定してください。
deliveryMethod - String! 配送方法名称

管理画面で設定されている配送方法を指定。
deliveryFee - Int64 配送⼿数料
desiredDeliveryDate - String 配達希望日

定期購入商品を含む注文の場合、「定期購入商品の初回お届け日」を指定してください。
desiredDeliveryTimezone - String

配達希望時間帯

管理画面で設定されている時間帯指定。

  • 午前中
  • 午後
  • 12:00-14:00
  • 14:00-16:00
  • 16:00-18:00
  • 18:00-20:00
  • 18:00-21:00
  • 19:00-21:00
Example
{
  "deliveryId": "01",
  "receiverName": "⼭⽥ 太郎",
  "receiverNameKana": "ヤマダ タロウ",
  "receiverCompany": "○○株式会社",
  "receiverCompanyKana": "○○カブシキガイシャ",
  "receiverCompanyDept": "○○部署",
  "receiverPost": 1508512,
  "receiverPrefectureCode": 13,
  "receiverAddress": "渋⾕区",
  "receiverAddress2": "○○町1-1-1",
  "receiverTel": "03-0000-0000",
  "deliveryMethod": "佐川急便",
  "deliveryFee": 500,
  "desiredDeliveryDate": "20241230",
  "desiredDeliveryTimezone": "12:00-14:00"
}
Types

DeliveryRequestInfoForUpdate

Description

お届け先（更新用）

Fields
Input Field Description
deliveryId - String 配送先ID
※ギフト配送の注文の場合は指定必須です。
receiverName - String お届け先の名前
receiverNameKana - String お届け先の名前（カナ）
receiverCompany - String お届け先の会社名
※BtoBオプション機能のご契約ショップ様が対象。
receiverCompanyKana - String お届け先の会社名（カナ）
※BtoBオプション機能のご契約ショップ様が対象。
receiverCompanyDept - String お届け先の部署名
※BtoBオプション機能のご契約ショップ様が対象。
receiverPost - String お届け先の郵便番号
※ハイフンなしで指定してください。
receiverPrefectureCode - Uint64 お届け先の都道府県コード
receiverAddress - String お届け先の市区町村
receiverAddress2 - String お届け先の以降の住所
receiverTel - String お届け先の電話番号
※ハイフンありで指定してください。
slipNumber - String 伝票番号
deliveryCompanyCode - String

配送業者コード

  • 001:ゆうパック
  • 002:クロネコヤマト
  • 003:佐川急便
  • 004:国際スピード郵便(USPS)
  • 006:西濃運輸
  • 007:福山通運
  • 008:EMS国際スピード郵便
  • 009:ゆうパック代金引換小包
  • 010:ゆうパック書留
  • 011:レターパック500
  • 012:翌朝10時郵便
  • 013:名鉄運輸
  • 014:OCS 国際エクスプレス
  • 015:普通郵便
  • 016:普通郵便代引き
  • 017:トナミ運輸
  • 018:トールエクスプレスジャパン
  • 019:エコ配
  • 020:レターパック350
  • 021:セイノースーパーエクスプレス
  • 022:新潟運輸
  • 023:DHL
  • 024:第一貨物
  • 025:ゆうパケット
  • 026:ポスパケット
  • 027:クリックポスト
  • 028:スマートレター
  • 029:宅急便コンパクト
  • 030:ネコポス
  • 031:クロネコDM便
  • 032:近物レックス
  • 033:中越運送
  • 034:クロネコゆうパケット
  • 035:クロネコゆうメール
estimatedShippingDate - String

出荷予定日

  • YYYY-MM-DD形式
desiredDeliveryDate - String

配達希望日

  • YYYY-MM-DD形式
desiredDeliveryTimezone - String

配達希望時間帯

  • 指定なし
  • 午前中
  • 午後
  • 12:00-14:00
  • 14:00-16:00
  • 14:00-17:00
  • 16:00-18:00
  • 17:00-19:00
  • 18:00-20:00
  • 18:00-21:00
  • 19:00-21:00
  • 20:00-21:00
consoleMemo - String 対応メモ
※通常配送の場合、（ショップ管理画面）注文一覧 > 注文詳細 > 対応メモ にて、入力内容が追記されます。
※ギフト配送の場合、（ショップ管理画面）注文一覧 > 注文詳細 > 配送詳細 > 対応メモ にて、入力内容が追記されます。
※「対応メモ」の入力可能文字数は最大1000文字となります。
※改行を伴う入力をしたい場合は「\n」を入力してください。
Example
{
  "deliveryId": "01",
  "receiverName": "⼭⽥ 太郎",
  "receiverNameKana": "ヤマダ タロウ",
  "receiverCompany": "○○株式会社",
  "receiverCompanyKana": "○○カブシキガイシャ",
  "receiverCompanyDept": "○○部署",
  "receiverPost": "1508512",
  "receiverPrefectureCode": 13,
  "receiverAddress": "渋⾕区",
  "receiverAddress2": "○○町1-1-1",
  "receiverTel": "03-0000-0000",
  "slipNumber": "12345678912",
  "deliveryCompanyCode": "003",
  "estimatedShippingDate": "2024-12-30",
  "desiredDeliveryDate": "2024-12-30",
  "desiredDeliveryTimezone": "12：00-14：00",
  "consoleMemo": "\"対応メモ1\n対応メモ2\""
}
Types

DeliveryStatus

Description

配送ステータス

Values
Enum Value Description

NOT_YET

 未配送

SHIPPING_INSTRUCTION

 配送指示

COMPLETED

 配送完了

RETURNED

 返送
Example
"NOT_YET"
Types

DetachCouponProduct

Fields
Input Field Description
code - String! クーポンコード
productCodes - [String!]! 対象商品コード
Example
{"code": "coupon", "productCodes": ["123456789"]}
Types

DetachCouponProductRequest

Description

対象商品削除リクエスト

Fields
Input Field Description
couponProducts - [DetachCouponProduct]!
Example
{"couponProducts": [DetachCouponProduct]}
Types

DetachCouponProductResponse

Description

対象商品削除レスポンス

Fields
Field Name Description
results - [DetachCouponProductResult!]
Example
{"results": [DetachCouponProductResult]}
Types

DetachCouponProductResult

Fields
Field Name Description
code - String クーポンコード
status - DetachCouponProductResultStatus!

結果ステータス

  • SUCCESS：成功
  • FAIL：失敗
errorMessage - String エラーメッセージ
※失敗した場合のみ設定されます
Example
{"code": "coupon", "status": "SUCCESS", "errorMessage": "エラーメッセージ"}
Types

DetachCouponProductResultStatus

Description

結果ステータス

Values
Enum Value Description

SUCCESS

 成功

FAIL

 失敗
Example
"SUCCESS"
Types

DetailInfo

Description

詳細情報

Fields
Input Field Description
maker - String 製造元
madeIn - String 原産地
janCode - String JANコード
weight - Uint64 重量
condition - String

商品の状態

  • new : 新品
  • used : 中古品
  • refurbished : 中古品を改修
specialDisplay - String 商品別特殊表示
orderMessage - String 備考欄表示テキスト設定
orderContent - String 決済画面用商品詳細
Example
{
  "maker": "テスト株式会社",
  "madeIn": "日本",
  "janCode": "1234567890123",
  "weight": 999,
  "condition": "refurbished",
  "specialDisplay": "商品別特殊表示",
  "orderMessage": "備考欄表示テキスト設定",
  "orderContent": "決済画面用商品詳細"
}
Types

DiscountDetail

Description

回数割引情報の明細データ

Fields
Field Name Description
numberOfDeliveries - Uint64 お届け回数
sellPrice - Uint64 販売価格
Example
{"numberOfDeliveries": 1, "sellPrice": 3000}
Types

DiscountPerTax

Description

税率毎割引額

Fields
Field Name Description
taxRate - Uint64! 税率
discount - Uint64! 割引額
Example
{"taxRate": 10, "discount": 1000}
Types

DiscountType

Description

割引タイプ

Values
Enum Value Description

FIXED_AMOUNT

 定額

FIXED_RATE

 定率

FREE_DELIVERY_FEE

 送料無料
Example
"FIXED_AMOUNT"
Types

Enhancement

Description

追加機能

Fields
Input Field Description
isRestockMail - Boolean

再入荷お知らせ

  • true : あり
  • false : 無し
productGroupCode - String 商品グループ
settlementGroupId - Uint64 決済グループ
insertNameGroupUid - Uint64 名入れ
productGoogleShopping - ProductGoogleShopping Googleショッピング
Example
{
  "isRestockMail": false,
  "productGroupCode": "20240205180457",
  "settlementGroupId": 1,
  "insertNameGroupUid": 1,
  "productGoogleShopping": ProductGoogleShopping
}
Types

ExternalUser

Description

外部連携サービスのユーザ情報

Fields
Field Name Description
service - Service! 外部サービス
id - String! 外部サービスのユーザID
Example
{"service": "LINE", "id": "makeshop123"}
Types

FeeByOrderAmount

Description

注文金額別の配送量

Fields
Field Name Description
minAmount - Int64 金額下限
maxAmount - Int64 金額上限
fee - Int64 配送料
Example
{"minAmount": 5000, "maxAmount": 10000, "fee": -500}
Types

FeeByOrderQuantity

Description

注文個数別の配送料

Fields
Field Name Description
minQuantity - Int64 個数下限
maxQuantity - Int64 個数上限
fee - Int64 配送料
Example
{"minQuantity": 1, "maxQuantity": 2, "fee": 300}
Types

FeeByWeight

Description

重量別の配送料

Fields
Field Name Description
minWeight - Int64 重量下限
maxWeight - Int64 重量上限
fee - Int64 配送料
Example
{"minWeight": 1, "maxWeight": 10, "fee": 200}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

GetAccessTagRequest

Description

アクセス解析タグ取得リクエスト

Fields
Input Field Description
key - String!

タグを識別するためのキー

許容文字: 英数字とアンダースコア, 下限: 1文字, 上限: 32文字
Example
{"key": "Access_tag_key01"}
Types

GetAccessTagResponse

Description

アクセス解析タグ取得レスポンス

Fields
Field Name Description
accessTag - AccessTag アクセス解析タグ
Example
{"accessTag": AccessTag}
Types

GetAppChargeReservationRequest

Description

自由決済予約取得リクエスト

Fields
Input Field Description
appChargeReservationId - Int64! 決済予約ID
Example
{"appChargeReservationId": 867}
Types

GetAppSubscriptionSettlementStatusResponse

Description

アプリサブスクリプション決済ステータスレスポンス

Fields
Field Name Description
status - AppSubscriptionSettlementStatus アプリサブスクリプション決済ステータス
Example
{"status": "OK"}
Types

GetAppSubscriptionStatusResponse

Description

アプリサブスクリプションステータスレスポンス

Fields
Field Name Description
status - AppSubscriptionStatus アプリサブスクリプションステータス
Example
{"status": "IN_USE"}
Types

GetShopDeliverySettingResponse

Description

ショップ配送設定情報取得レスポンス

Fields
Field Name Description
delivery - Delivery 配送
Example
{"delivery": Delivery}
Types

GetShopOrderPrintResponse

Description

ショップ納品明細書情報取得レスポンス

Fields
Field Name Description
orderPrint - OrderPrint 納品明細書
Example
{"orderPrint": OrderPrint}
Types

GetShopResponse

Description

ショップ情報取得レスポンス

Fields
Field Name Description
shop - ShopBasic! ショップ基本情報
member - ShopMember!

会員管理

会員の設定
order - ShopOrder!

注文

注文の設定
settlement - ShopSettlement!

決済

決済方法の設定
Example
{
  "shop": ShopBasic,
  "member": ShopMember,
  "order": ShopOrder,
  "settlement": ShopSettlement
}
Types

GetShopSignatureImageResponse

Description

ショップ社印画像取得レスポンス

Fields
Field Name Description
signatureImageUrl - String 社印画像URL
Example
{
  "signatureImageUrl": "https://shop〇〇.makeshop.jp/shopimages/ショップID/orderSealImpression729256.jpg"
}
Types

ImageInfo

Description

画像情報
※「商品のメイン画像」、「商品のサブ画像」を設定する場合は、content-typeは設定できません。

Fields
Input Field Description
mainImage - Upload 商品のメイン画像
※削除指定されている場合は設定できません。
subImages - [Upload] 商品のサブ画像
※削除指定されている場合は設定できません。
isDeleteMainImage - Boolean

商品のメイン画像を削除

  • true : 削除する
  • false : 削除しない
deleteSubImageIDs - [Uint64!] 削除用商品のサブ画像ID
Example
{
  "mainImage": Upload,
  "subImages": [Upload],
  "isDeleteMainImage": false,
  "deleteSubImageIDs": [Uint64]
}
Types

InsertNameGroup

Description

名入れグループ情報

Fields
Field Name Description
groupUID - Uint64 名入れグループID
groupName - String 名入れグループ名
groupDescription - String 名入れグループの説明文
InsertNameSettings - [InsertNameSetting] 名入れ項目設定情報
Example
{
  "groupUID": 1,
  "groupName": "名入れグループ1　管理用グループ名",
  "groupDescription": "名入れグループの説明文",
  "InsertNameSettings": [InsertNameSetting]
}
Types

InsertNameSetting

Description

名入れ項目設定情報

Fields
Field Name Description
displayOrder - Uint64 名入れ入力項目の順番
adminItemName - String 名入れ入力項目の管理用項目名
itemName - String 名入れ入力項目の表示用項目名 本項目が未設定（空）の場合は管理用項目名をショップ画面に表示する。
isRequired - String

名入れ入力項目の入力項目の必須設定

  • Y: 必須項目
  • N: 任意項目
isAlphabetOk - String

名入れ入力項目の半角英字の入力設定

  • Y: 半角アルファベットの入力可
  • N: 半角アルファベットの入力不可
isNumberOk - String

名入れ入力項目の半角数字の入力設定

  • Y: 半角数字の入力可
  • N: 半角数字の入力不可
isSymbolOk - String

名入れ入力項目の半角記号の入力設定

  • Y: 半角記号の入力可
  • N: 半角記号の入力不可
isDoubleByteCharacterOk - String

名入れ入力項目のマルチバイト文字の入力設定

  • Y: マルチバイト文字の入力可
  • N: マルチバイト文字の入力不可
inputMaxLength - Uint64 名入れ入力項目の入力可能文字数の設定
rowMaxLength - Uint64 名入れ入力項目の１行に入力可能な文字数の設定
displayRows - Uint64 名入れ入力項目の入力可能な行数の設定
Example
{
  "displayOrder": 1,
  "adminItemName": "名入れグループ1 管理用項目名",
  "itemName": "名入れ",
  "isRequired": "Y",
  "isAlphabetOk": "Y",
  "isNumberOk": "Y",
  "isSymbolOk": "Y",
  "isDoubleByteCharacterOk": "Y",
  "inputMaxLength": 20,
  "rowMaxLength": 20,
  "displayRows": 1
}
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987
Types

Int64

Example
Int64
Types

IsCardCheck

Description

定期注文情報取得　有効性チェックを示すENUM値

Values
Enum Value Description

OK

 有効性OK

NG

 有効性NG
Example
"OK"
Types

KuronekoCreditCard

Description

クロネコ クレカ払いの設定

Fields
Field Name Description
settingKuronekoCreditCard - String

クロネコ クレカ払いの利用設定

  • Y … 利用する
  • N … 利用しない
settingPayment - SettingKuronekoCreditCardPayment お支払い方法の設定
settingSecure - String

3Dセキュアの利用設定

  • Y … 利用する
  • N … 利用しない
Example
{
  "settingKuronekoCreditCard": "N",
  "settingPayment": SettingKuronekoCreditCardPayment,
  "settingSecure": "N"
}
Types

KuronekoPayLater

Description

クロネコ代金後払いの設定

Fields
Field Name Description
settingKuronekoPayLater - String

クロネコ代金後払い利用設定

  • Y … 利用する
  • N … 利用しない
settingDeliveryCompany - String

配送業者の設定

  • 1 … ヤマトグループのみ
  • 2 … ヤマトグループ以外の配送業者も利用する
settingPayLaterFees - [SettingFee]

後払い決済手数料

後払い決済手数料を購入者に負担していただく場合の決済手数料設定
Example
{
  "settingKuronekoPayLater": "N",
  "settingDeliveryCompany": "1",
  "settingPayLaterFees": [SettingFee]
}
Types

KuronekoWebCollectConvenience

Description

クロネコwebコレクト コンビニ決済の設定

Fields
Field Name Description
settingConvenience - String

クロネコwebコレクト コンビニ決済の利用設定

  • Y … 利用する
  • N … 利用しない
settingConvenienceFees - [SettingFee]

クロネコwebコレクト コンビニ決済手数料設定

コンビニ決済手数料を購入者に負担していただく場合の決済手数料設定
Example
{
  "settingConvenience": "N",
  "settingConvenienceFees": [SettingFee]
}
Types

KuronekoWebCollectCreditCard

Description

クロネコwebコレクト クレジットカードの設定

Fields
Field Name Description
settingCreditCard - String

クロネコwebコレクト クレジットカードの利用設定

  • Y … 利用する
  • N … 利用しない
settingDeliveryCompany - String

配送業者の設定

  • 1 … ヤマトグループのみ
  • 2 … ヤマトグループ以外の配送業者も利用する
settingPayment - SettingKuronekoWebCollectCreditCardPayment お支払い方法の設定
settingCardSave - String

クレジットカード情報保持機能の利用設定

  • Y … 利用する
  • N … 利用しない
settingSecure - String

3Dセキュアの利用設定

  • Y … 利用する
  • N … 利用しない
settingReCredit - String

再与信機能の利用設定

  • Y … 利用する
  • N … 利用しない
settingCreditSaveDay - Uint64

与信保持日数

31～60の間で指定可能
settingReCreditTiming - Uint64

再与信タイミング

7～15の間で指定可能
Example
{
  "settingCreditCard": "N",
  "settingDeliveryCompany": "1",
  "settingPayment": SettingKuronekoWebCollectCreditCardPayment,
  "settingCardSave": "N",
  "settingSecure": "N",
  "settingReCredit": "N",
  "settingCreditSaveDay": 60,
  "settingReCreditTiming": 10
}
Types

MemberAddEntryFields

Description

会員の設定：追加入力項目の設定

Fields
Field Name Description
number - Uint64

順序

1～7
name - String 項目名
maxLength - Uint64 入力可能文字数
required - String

必須・任意選択

  • Y … 必須
  • N … 任意
Example
{"number": 1, "name": "当店を知ったきっかけを教えてください", "maxLength": 200, "required": "N"}
Types

MemberGroupPrice

Description

会員グループ別価格

Fields
Input Field Description
groupId - Int64 会員グループID
price - Int64 会員グループ別価格
point - Int64 会員グループポイント
pointType - Int64

ポイント設定

  • 0 : なし
  • 1 : 付与値
  • 2 : 付与率
perVariations - [PerVariation] バリエーション別価格情報
Example
{
  "groupId": 1,
  "price": 9999,
  "point": 1,
  "pointType": 2,
  "perVariations": [PerVariation]
}
Types

MemberGroupPriceForSearch

Description

会員グループ別価格（検索用）

Fields
Field Name Description
groupId - Int64 会員グループID
groupName - String 会員グループ名
price - Int64 会員グループ別価格
point - Int64 会員グループポイント付与値
pointRate - Int64 会員グループポイント付与率
perVariations - [PerVariationForSearch] バリエーション別価格情報
Example
{
  "groupId": 1,
  "groupName": "テストグループ",
  "price": 2200,
  "point": 100,
  "pointRate": 1,
  "perVariations": [PerVariationForSearch]
}
Types

MemberInfo

Description

会員情報

Fields
Field Name Description
groupId - String! 会員グループID
groupName - String! 会員グループ名
memberId - String! 会員ID
name - String 会員名
nameKana - String 会員名(カナ)
email - String メールアドレス
mailMagazineFlag - String

メールマガジン受信可否

  • Y：希望する
  • N：希望しない
sex - String

性別

  • 0：男性
  • 1：女性
  • 2：無回答

※無回答(2024.06.13追加)
birthday - String 生年月日
shopPoint - Int64 保有ショップポイント
reserveExpireDate - String! 保有ショップポイント満了日
recommendId - String 紹介者ID
hpost - String 郵便番号(自宅)
haddress1 - String 都道府県コード(自宅)
haddressAddr - String 都道府県文字列(自宅)
haddress2 - String 市区町村(自宅)
haddress - String その他住所等(自宅)
tel - String 電話番号(自宅)
fax - String FAX番号(自宅)
etcphone - String 電話番号(携帯)
hpEmail - String メールアドレス(携帯)
officename - String 会社名
officenameKana - String 会社名(カナ)
officedept - String 所属部署名
opost - String 郵便番号(会社)
oaddress1 - String 都道府県コード(会社)
oaddressAddr - String 都道府県文字列(会社)
oaddress - String 市区町村(会社)
ophone - String 電話番号(会社)
etc - [String] 追加入力項目
confirm - String

メールアドレス認証設定

  • Y：認証された会員
  • N：認証されていない会員
registrationDate - String 登録日
shopMemo - String 会員情報メモ
modified - String

最終更新日時

  • YYYYMMDDhhmmss形式
    ※新規会員登録時にも値を返却
delFlag - String

削除会員フラグ

  • Y：論理削除会員
  • N：論理削除会員でない
memberFlag - String

会員フラグ

  • Y：登録
  • N：解除
lockStatusFlag - String!

ロックステータスフラグ

  • Y：ロックしている
  • N：ロックしてない
lockTime - Timestamp ロック日時
lockClearApplyTime - Timestamp ロック解除日時
externalUsers - [ExternalUser!]! 外部連携サービスのユーザ情報
(2024.07.12追加)
loginEmailAuth - String

メールアドレスログイン可否

  • Y：ログイン可
  • N：ログイン不可
Example
{
  "groupId": "1",
  "groupName": "ゴールド会員",
  "memberId": "230517000001",
  "name": "メイク太郎",
  "nameKana": "メイクタロウ",
  "email": "info@example.com",
  "mailMagazineFlag": "Y",
  "sex": "0",
  "birthday": "20000101",
  "shopPoint": 10,
  "reserveExpireDate": "20240531",
  "recommendId": "230517000001",
  "hpost": "0000000",
  "haddress1": "13",
  "haddressAddr": "東京(23区内)",
  "haddress2": "渋谷区",
  "haddress": "○○町1-1-1",
  "tel": "00-0000-0000",
  "fax": "03-2222-2222",
  "etcphone": "090-1111-1111",
  "hpEmail": "info2@example.com",
  "officename": "○○株式会社",
  "officenameKana": "○○カブシキガイシャ",
  "officedept": "○○部署",
  "opost": "1111111",
  "oaddress1": "13",
  "oaddressAddr": "東京(23区内)",
  "oaddress": "新宿区○○町1-1-1",
  "ophone": "03-1111-1111",
  "etc": ["友人からの紹介"],
  "confirm": "Y",
  "registrationDate": "20230517170613",
  "shopMemo": "お得意様",
  "modified": "20230525144045",
  "delFlag": "N",
  "memberFlag": "Y",
  "lockStatusFlag": "N",
  "lockTime": "2023-05-31 18:21:55",
  "lockClearApplyTime": "2023-05-31 18:29:05",
  "externalUsers": [ExternalUser],
  "loginEmailAuth": "Y"
}
Types

MemberPoint

Description

会員の設定：会員ポイント機能の設定

Fields
Field Name Description
settingPointSystem - String

ポイント制度の利用設定

  • Y … ポイント制度を適用する
  • N … ポイント制度を適用しない
expirationMonth - Int64

ポイント有効期限

ポイント有効期限の設定（1～36ヵ月）
newMemberBonusPoint - Int64

会員登録時の付与ポイント

新規会員登録のボーナスポイント
applyStandardValue - Int64

ポイント適用基準

ポイントがこのカラムの値以上の場合は購入時に利用可能
settingPointUsageLimit - String

ポイント利用制限の利用設定

  • Y … ポイント制限を利用する
  • N … ポイント制限を利用しない
usePointLimit - String

利用ポイント上限

一度に顧客が利用可能な最大ポイント値
usePointTarget - String

ポイント利用対象

  • Y … 商品代金＋送料
  • N … 商品代金のみ
addTimingDate - Int64

ポイント付与タイミングの設定

0なら配送完了時に付与する 1以上なら配送完了から○日後（※）に付与する ※このカラムの値が日数になる
settingMemberIntroductionSystem - String

会員紹介機能の利用設定

  • Y … 使用する
  • N … 使用しない
introducedBonusPoint - Int64 紹介者に付与するポイント
introducedMeBonusPoint - Int64 紹介された会員に付与するポイント
referee - Uint64

紹介人数の制限

0 なら無制限
Example
{
  "settingPointSystem": "Y",
  "expirationMonth": 0,
  "newMemberBonusPoint": 0,
  "applyStandardValue": 0,
  "settingPointUsageLimit": "Y",
  "usePointLimit": "10000",
  "usePointTarget": "N",
  "addTimingDate": 0,
  "settingMemberIntroductionSystem": "Y",
  "introducedBonusPoint": 0,
  "introducedMeBonusPoint": 0,
  "referee": 1
}
Types

MemberShopPoint

Description

会員ポイント情報

Fields
Field Name Description
point - Uint64! ショップポイント
expireDate - String! ポイント期間（YYYYMMDD）
comment - String! 最新の更新理由
Example
{"point": 200, "expireDate": "20240801", "comment": "キャンペーン"}
Types

Option

Description

オプション情報

Fields
Field Name Description
optionCode - String オプションID
optionTitle - String オプション名
optionSelect - String 詳細オプション1〜10の必須設定
optionDefault - String 詳細オプション1〜10のデフォルト値のインデックス
optionValue0 - String 詳細オプション1の項目
optionValue1 - String 詳細オプション2の項目
optionValue2 - String 詳細オプション3の項目
optionValue3 - String 詳細オプション4の項目
optionValue4 - String 詳細オプション5の項目
optionValue5 - String 詳細オプション6の項目
optionValue6 - String 詳細オプション7の項目
optionValue7 - String 詳細オプション8の項目
optionValue8 - String 詳細オプション9の項目
optionValue9 - String 詳細オプション10の項目
optionValue10 - String 詳細オプション11の項目
optionValue11 - String 詳細オプション12の項目
optionValue12 - String 詳細オプション13の項目
optionValue13 - String 詳細オプション14の項目
optionValue14 - String 詳細オプション15の項目
optionValue15 - String 詳細オプション16の項目
optionValue16 - String 詳細オプション17の項目
optionValue17 - String 詳細オプション18の項目
optionValue18 - String 詳細オプション19の項目
optionValue19 - String 詳細オプション20の項目
Example
{
  "optionCode": "1000",
  "optionTitle": "オプショングループ1(管理者向け)",
  "optionSelect": "0,0",
  "optionDefault": "-1,-1",
  "optionValue0": "サイズ,S|0,M|0,L|0",
  "optionValue1": "保証の有無,不要|0,3年保証を付ける|1000",
  "optionValue2": null,
  "optionValue3": null,
  "optionValue4": null,
  "optionValue5": null,
  "optionValue6": null,
  "optionValue7": null,
  "optionValue8": null,
  "optionValue9": null,
  "optionValue10": null,
  "optionValue11": null,
  "optionValue12": null,
  "optionValue13": null,
  "optionValue14": null,
  "optionValue15": null,
  "optionValue16": null,
  "optionValue17": null,
  "optionValue18": null,
  "optionValue19": null
}
Types

OptionGroup

Description

オプショングループ

Fields
Input Field Description
optionId - Uint64 オプションID

※オプショングループ商品の場合、入力が必須です。
itemId - Uint64 アイテムID

※オプショングループ商品の場合、入力が必須です。
項目を選択しない場合は0を指定してください。
specifyAmount - Int64 追加⾦額

オプショングループの追加金額を指定してください。
指定された値がそのまま登録されます。
負数の場合、減算の値
整数の場合、加算の値
として登録されます。
Example
{"optionId": 1, "itemId": 1, "specifyAmount": 200}
Types

OptionalFeature

Description

オプション機能

Fields
Input Field Description
reservationSaleInfo - ReservationSaleInfo 予約商品関連情報
※予約販売機能のご契約ショップ様が対象。
repeatSaleInfo - RepeatSaleInfo 定期購入関連情報
※定期購入機能のご契約ショップ様が対象。
repeatSaleProducts - [RepeatSaleProduct] 定期販売 回数割引
※定期購入機能のご契約ショップ様が対象。
catalogCode - String カタログ注文番号
※カタログ注文機能のご契約ショップ様が対象。
isMemberOnly - Boolean

会員専用可否

  • true : 専用
  • false : 非専用

※BtoBオプション機能のご契約ショップ様が対象。
memberGroupIdDisplayForProduct - [Int64] 会員専用表示対象の会員グループID
※BtoBオプション機能のご契約ショップ様が対象。
※会員専用表示対象の会員グループIDを設定済から未設定に変更する場合は空配列を指定してください。
memberGroupPrices - [MemberGroupPrice] 会員グループ別価格
※BtoBオプション機能のご契約ショップ様が対象。
Example
{
  "reservationSaleInfo": ReservationSaleInfo,
  "repeatSaleInfo": RepeatSaleInfo,
  "repeatSaleProducts": [RepeatSaleProduct],
  "catalogCode": "catalog-0001",
  "isMemberOnly": false,
  "memberGroupIdDisplayForProduct": [Int64],
  "memberGroupPrices": [MemberGroupPrice]
}
Types

OrderPaymentInfo

Description

決済情報

Fields
Input Field Description
paymethod - Paymethod! 決済方法

管理画面で設定されている決済方法を指定
returnUrl - String 外部決済完了時の戻り先URL
bankinfo - String 銀⾏振込先情報
※決済方法が「BANK」の場合、入力が必須です。
paymentToken - String 決済トークン

※決済方法がクレジットカードの場合、入力が必須です。
GMO-PG、GMOイプシロンで⽣成したワンタイムトークンを入力してください。
決済方法が「CREDIT_CARD_PG」且つ、カード保存フラグが「true」の場合は入力は不要です。
creditCardCorp - String クレジットカード会社名

※決済方法がクレジットカードの場合、入力が必須です。
repayMethod - String 代引き時の決済方法

※「代金引換」の場合、入力が必須です。（設定されてない場合、空で登録）
代金引換利用時の配送時の代金の決済方法を指定してください。
管理画面に存在する代金引換配送時の決済方法を指定してください。
memberId - String 会員ID

※決済方法が「CREDIT_CARD_PG」且つ、カード保存フラグが「true」の場合は入力が必須です。
ショップに登録されている会員IDを指定してください。
useSavedCreditCard - Boolean 保存クレジットカード
saveCreditCard - Boolean カード保存フラグ
creditCardSlot - Uint64 クレジットカードスロット

※PGクレジットカードのみ使用可能
totalTax - Uint64! 消費税合計
taxType - TaxType! 消費税タイプ
taxCalculationMethod - TaxCalculationMethod! 消費税計算方法
deliveryFee - Int64 配送⼿数料合計
paymentFee - Int64 決済⼿数料
correctionAmount - Int64 項目外の値引き・付随費用

負数の場合、減算の修正額
整数の場合、加算の修正額
として登録されます。
usePoint - Int64 ポイント利用額

ポイント利用額の利用には会員IDを指定してください。
ポイント制度を利用する設定になっていない場合や、保有ポイント以上や制限ポイント以上のポイント利用額を指定するとエラーとなります。
price - Uint64! 請求金額

商品価格や割引額などの累計と指定金額が異なる場合も、指定された金額が合計金額として登録されます。
taxDetail - [OrderPriceInfoPerTaxRateInput!]! 税金詳細
Example
{
  "paymethod": "BANK",
  "returnUrl": "https://example.com",
  "bankinfo": "三菱UFJ銀⾏",
  "paymentToken": "603d844dfaf8c51a8ef55bcfe4b4c9f21d23563f7bbc4807f1eedecc61410c1e",
  "creditCardCorp": "MASTER",
  "repayMethod": "現金決済",
  "memberId": "180723000002",
  "useSavedCreditCard": false,
  "saveCreditCard": false,
  "creditCardSlot": 1,
  "totalTax": 100,
  "taxType": "WITHOUT_TAX_INCLUDED",
  "taxCalculationMethod": "ROUND_UP",
  "deliveryFee": 500,
  "paymentFee": 300,
  "correctionAmount": -200,
  "usePoint": 100,
  "price": 2980,
  "taxDetail": [OrderPriceInfoPerTaxRateInput]
}
Types

OrderPriceInfoPerTaxRate

Description

税率ごとの価格や税額の情報

Fields
Field Name Description
taxRate - Uint64! 税率
tax - Uint64! 消費税
taxIncludedPrice - Uint64! 税込価格
Example
{"taxRate": 10, "tax": 227, "taxIncludedPrice": 2500}
Types

OrderPriceInfoPerTaxRateInput

Description

税率ごとの価格や税額の情報インプット

Fields
Input Field Description
taxRate - Uint64! 税率
tax - Uint64! 消費税
taxIncludedPrice - Uint64! 税込価格
Example
{"taxRate": 10, "tax": 227, "taxIncludedPrice": 2500}
Types

OrderPrint

Description

納品明細書

Fields
Field Name Description
invoiceNum - String

適格請求書発行事業者登録番号

税務署長の登録を受けた事業者に通知される登録番号
Example
{"invoiceNum": "T7011001046363"}
Types

OrderProduct

Description

注文する商品情報
※最大50件まで

Fields
Input Field Description
systemCode - String! システム商品コード

管理画面に存在するシステム商品コードを指定。
同一注文に同じ商品コードの指定はできません。
productName - String! 商品名

指定された名称がそのまま登録されます。
productPrice - Int64! 商品の販売価格

指定された価格がそのまま登録されます。
オプショングループ商品の場合、追加金額を含んだ金額を指定してください。
orderAmount - Uint64! 数量
deliveryId - String 配送先ID
※ギフト配送注文の場合のみ
addPoint - Int64 付与ポイント

付与ポイントを指定する場合は、会員IDが必須となります。
taxRate - Uint64! 消費税率
reducedTaxRate - Boolean 軽減税率区分
repeatSaleProduct - Boolean 定期購⼊商品フラグ
true：定期購⼊商品
false：通常商品

※ギフト注文フラグが「true」の場合は利用できません。
variation1ItemId - Uint64 バリエーション1項⽬ID
variation2ItemId - Uint64 バリエーション2項⽬ID
optionGroup - [OptionGroup] オプショングループ
productNameOption - ProductNameOption 名入れ
(2024.08.29追加)
Example
{
  "systemCode": "000000000001",
  "productName": "Tシャツ",
  "productPrice": 1980,
  "orderAmount": 1,
  "deliveryId": "01",
  "addPoint": 10,
  "taxRate": 8,
  "reducedTaxRate": false,
  "repeatSaleProduct": false,
  "variation1ItemId": 1,
  "variation2ItemId": 2,
  "optionGroup": [OptionGroup],
  "productNameOption": ProductNameOption
}
Types

OrderRequest

Fields
Input Field Description
id - String! Response識別用のID
orderMemo - String 管理者メモ
isGiftOrder - Boolean ギフト注文フラグ 未指定の場合はfalseとして扱う
couponCode - String クーポンコード
管理画面で設定されているクーポンコードを指定。
couponDiscountPrice - Uint64 クーポン割引額
※クーポンコード入力時はクーポン割引額も入力が必須。 ※定額割引のみ対応
paymentInfo - OrderPaymentInfo! 決済情報
customerInfo - CustomerInfo! 注文者情報
deliveryRequestInfo - [DeliveryRequestInfo!]! お届け先情報
cycleInfo - CycleInfo お届けサイクル情報
orderProduct - [OrderProduct!]! 注文する商品情報
Example
{
  "id": "202305251",
  "orderMemo": "xxxxキャンペーンでの注⽂",
  "isGiftOrder": false,
  "couponCode": "882nbstae53fia058jhr",
  "couponDiscountPrice": 500,
  "paymentInfo": OrderPaymentInfo,
  "customerInfo": CustomerInfo,
  "deliveryRequestInfo": [DeliveryRequestInfo],
  "cycleInfo": CycleInfo,
  "orderProduct": [OrderProduct]
}
Types

OrderResult

Fields
Field Name Description
id - String! 注文の結果
status - CreateOrderResult! 結果ステータス SUCCESS：成功 FAIL：失敗 ACTION_REQUIRED：注文処理を継続するのに追加の操作が必要（3Dセキュア等）
paymentRedirectUrl - String 決済用リダイレクトURL
paymentAdditionalParameter - PaymentAdditionalParameter 決済用リダイレクトURL
systemOrderNumber - String システム注文番号
displayOrderNumber - String 注文番号
errorMessage - String エラーメッセージ
Example
{
  "id": "202305251",
  "status": "SUCCESS",
  "paymentRedirectUrl": "https://example.com",
  "paymentAdditionalParameter": PaymentAdditionalParameter,
  "systemOrderNumber": "20230525175146230517000001",
  "displayOrderNumber": "P170000000000000000",
  "errorMessage": "invalid"
}
Types

OrderSubscriptionAddress

Description

住所情報

Fields
Field Name Description
post - String 郵便番号
area - String 都道府県
address - String 住所
address2 - String 住所2
Example
{
  "post": "0000000",
  "area": "東京(23区内)",
  "address": "渋谷区",
  "address2": "○○町1-1-1"
}
Types

OrderSubscriptionDelivery

Description

配送

Fields
Field Name Description
deliveryReceiver - OrderSubscriptionDeliveryReceiverInfo 配送先
deliveryInfo - OrderSubscriptionDeliveryInfo 配送情報
orderRemarks - [OrderSubscriptionOrderRemark] 注文備考
memo - OrderSubscriptionMemo メモ
Example
{
  "deliveryReceiver": OrderSubscriptionDeliveryReceiverInfo,
  "deliveryInfo": OrderSubscriptionDeliveryInfo,
  "orderRemarks": [OrderSubscriptionOrderRemark],
  "memo": OrderSubscriptionMemo
}
Types

OrderSubscriptionDeliveryInfo

Description

配送情報

Fields
Field Name Description
deliveryCycleId - String お届けサイクルID
deliveryCycleName - String お届けサイクル
deliveryHopeTime - String 配送希望時間帯
deliveryNextDatePlan - Timestamp 次回お届け予定日
deliveryCountNow - Uint64 現在までのお届け回数
deliveryMethod - [String] 配送方法
orderNextDateFix - Timestamp 次回注文確定日
Example
{
  "deliveryCycleId": "20230524162437",
  "deliveryCycleName": "毎月1日にお届け",
  "deliveryHopeTime": "12:00-14:00",
  "deliveryNextDatePlan": "2023-07-01 00:00:00",
  "deliveryCountNow": 1,
  "deliveryMethod": [null],
  "orderNextDateFix": "2023-06-01 00:00:00"
}
Types

OrderSubscriptionDeliveryReceiverInfo

Description

配送先

Fields
Field Name Description
receiverName - String 受取人
receiverNameKana - String フリガナ
receiverTel - String 受取人連絡先
receiverAddress - OrderSubscriptionAddress 送付先
Example
{
  "receiverName": "メイク太郎",
  "receiverNameKana": "メイクタロウ",
  "receiverTel": "00-0000-0000",
  "receiverAddress": OrderSubscriptionAddress
}
Types

OrderSubscriptionGiftInfo

Description

景品情報

Fields
Field Name Description
giftCount - Uint64 同梱する回数
giftName - String 景品名
Example
{"giftCount": 3, "giftName": "○○プチお試しセット"}
Types

OrderSubscriptionMemo

Description

メモ

Fields
Field Name Description
subscriotionMemo - String 定期購入メモ
orderMemo - String 注文情報メモ
Example
{
  "subscriotionMemo": "2023/6/1　A商品→B商品に変更",
  "orderMemo": "7/1以降住所変更とのこと\n○○県…→○○都…"
}
Types

OrderSubscriptionOrderBasicInfo

Description

注文基本情報

Fields
Field Name Description
orderSubscriptionId - String 定期購入ID
orderSubscriptionPayMethodCode - String 決済方法コード
orderSubscriptionPayMethodName - String 決済方法名称
modified - String!

定期注文更新日時
(2024.05.24追加)

  • YYYYMMDDhhmmss形式
    ※新規受注時にも値を返却
Example
{
  "orderSubscriptionId": "TK17668554950967546",
  "orderSubscriptionPayMethodCode": "R",
  "orderSubscriptionPayMethodName": "代金引換",
  "modified": "20230522164110"
}
Types

OrderSubscriptionOrderHistory

Description

注文履歴

Fields
Field Name Description
ordernum - String 注文番号(システム用)
ordernumManage - String 注文番号(表示用)
deliveryCount - Uint64 配送回数
orderHistoryCreated - Timestamp 注文確定日
deliveryHopeDate - String 配送希望日
payMethodCode - String お支払方法コード
payMethodName - String お支払方法名称
deliveryStatusCode - String 配送ステータスコード
deliveryStatusName - String 配送ステータス名称
Example
{
  "ordernum": "20230525175146230517000001",
  "ordernumManage": "P176685549502061145",
  "deliveryCount": 1,
  "orderHistoryCreated": "2023-05-25 17:51:46",
  "deliveryHopeDate": "2023-06-01",
  "payMethodCode": "R",
  "payMethodName": "代金引換",
  "deliveryStatusCode": "N",
  "deliveryStatusName": "UNTREATED"
}
Types

OrderSubscriptionOrderRemark

Description

注文備考

Fields
Field Name Description
ItemName - String 項目名
Content - String 内容
Example
{"ItemName": "伝達メッセージ", "Content": "最短でのお届けを希望します"}
Types

OrderSubscriptionOrderSenderInfo

Description

注文者情報

Fields
Field Name Description
memberId - String 会員ID
senderName - String 注文者名
senderNameKana - String フリガナ
senderTel - String 注文者連絡先
senderTel2 - String 注文者緊急連絡先
senderEmail - String 電子メール
senderAddress - OrderSubscriptionAddress 注文者住所
Example
{
  "memberId": "230517000001",
  "senderName": "メイク太郎",
  "senderNameKana": "メイクタロウ",
  "senderTel": "00-0000-0000",
  "senderTel2": null,
  "senderEmail": "info@example.com",
  "senderAddress": OrderSubscriptionAddress
}
Types

OrderSubscriptionPrice

Description

価格情報

Fields
Field Name Description
price - Uint64 販売価格
taxRate - Uint64 税率
taxCalculation - String

税計算方法

  • ROUND : 端数四捨五入
  • FLOOR : 端数切り捨て
  • CEIL : 端数切り上げ
taxInclude - Boolean

税込みフラグ

  • true : 税込み
  • false : 税別
Example
{"price": 3000, "taxRate": 10, "taxCalculation": "ROUND", "taxInclude": false}
Types

OrderSubscriptionProduct

Description

購入商品

Fields
Field Name Description
systemCode - String 商品コード
productName - String 購入商品名
spName - String 選択
spName2 - String 選択2
amount - Uint64 数量
sellPrice - OrderSubscriptionPrice 価格情報
tax - Uint64 消費税
giftInfo - [OrderSubscriptionGiftInfo] 景品情報
Example
{
  "systemCode": "000000000004",
  "productName": "定期購入　毎月1日サイクル",
  "spName": "カラー : yellow",
  "spName2": "サイズ : S",
  "amount": 1,
  "sellPrice": OrderSubscriptionPrice,
  "tax": null,
  "giftInfo": [OrderSubscriptionGiftInfo]
}
Types

PaymentAdditionalParameter

Fields
Field Name Description
paReq - String Epsilon用リダイレクトパラメータ1
mD - String Epsilon用リダイレクトパラメータ2
termUrl - String Epsilon用コールバックURL
Example
{
  "paReq": "abc123",
  "mD": "xyz789",
  "termUrl": "https://example.com"
}
Types

PaymentDetail

Description

決済詳細

Fields
Field Name Description
amount - Uint64! 課金金額
tax - Uint64! 税総額
taxRate - Uint64! 税率
totalPrice - Uint64! 税込支払額
kind - String! 内訳種別 (BUYOUT, SUBSCRIPTION, INITIAL, TRIAL)
targetPeriodFrom - String 対象期間(from)
targetPeriodTo - String 対象期間(to)
Example
{
  "amount": 867,
  "tax": 86,
  "taxRate": 10,
  "totalPrice": 953,
  "kind": "BUYOUT",
  "targetPeriodFrom": "2023-06-01 00:00:00",
  "targetPeriodTo": "2023-07-31 23:59:59"
}
Types

PaymentInfo

Description

決済情報

Fields
Field Name Description
status - String 決済ステータス
type - String 支払い形態
salesDate - String 支払日
price - Uint64! 支払総額
tax - Uint64! 税総額
totalPrice - Uint64! 税込支払総額
fincodeOrderId - String FincodeオーダーID
Fincodeにて、決済に紐づく注文を一意とするID。1決済あたりに発行される。
planInfo - PlanInfo! プラン情報
paymentDetails - [PaymentDetail!]! 決済詳細
Example
{
  "status": "CAPTURED",
  "type": "card",
  "salesDate": "2023-06-20 00:00:00",
  "price": 867,
  "tax": 86,
  "totalPrice": 953,
  "fincodeOrderId": "o_xxxxxxxxxxxxxxxxxxxxxx",
  "planInfo": PlanInfo,
  "paymentDetails": [PaymentDetail]
}
Types

PaymentStatus

Description

決済ステータス

Values
Enum Value Description

UNPROCESSED

 未決済

AUTHORIZED

 仮売上

CAPTURED

 決済済み

CANCEL_RESERVED

 キャンセル予約

CANCELED

 キャンセル済み

ERRORED

 エラー
Example
"UNPROCESSED"
Types

Paymethod

Description

支払い方法

Values
Enum Value Description

BANK

 銀行振込

POST_OFFICE

 郵便振込

NP_DEFFERED

 NP後払い

CREDIT_CARD_PG

 PGクレジットカード

CREDIT_CARD_EPSILON

 イプシロンクレジットカード

CASH_ON_DELIVERY

 代金引換
Example
"BANK"
Types

PerVariation

Description

バリエーション別価格情報

Fields
Input Field Description
variation1ItemName - String バリエーション1項目名
variation2ItemName - String バリエーション2項目名
price - Int64 バリエーション別価格
Example
{"variation1ItemName": "L", "variation2ItemName": "橙色", "price": 9999}
Types

PerVariationForSearch

Description

バリエーション別価格情報（検索用）

Fields
Field Name Description
variation1ItemId - Int64 バリエーション1項目ID
variation1ItemName - String バリエーション1項目名
variation2ItemId - Int64 バリエーション2項目ID
variation2ItemName - String バリエーション2項目名
price - Int64 バリエーション別価格
Example
{
  "variation1ItemId": 1,
  "variation1ItemName": "LL",
  "variation2ItemId": 2,
  "variation2ItemName": "橙色",
  "price": 2222
}
Types

PlanInfo

Description

プラン情報

Fields
Field Name Description
id - Uint64! プランID
name - String! プラン名
fincodePlanId - String fincodeプランID
Example
{
  "id": 4,
  "name": "SubscriptionPlan",
  "fincodePlanId": "pl_xxxxxxxxxxxxxxxxxxxxxx"
}
Types

ProductBasicInfo

Description

基本情報

Fields
Input Field Description
customCode - String 独自商品コード
display - Boolean

公開ステータス

  • true : 公開
  • false : 非公開
productType - Uint64

商品種別

  • 1 : 通常商品
  • 2 : 予約商品
  • 3 : 定期購入商品
productName - String 商品名 （商品情報登録時は指定必須）
isUpdateProductOrder - Boolean

商品更新日を上書きする

  • true : 上書きする
  • false : 上書きしない
productDesc - ProductDesc 商品説明
Example
{
  "customCode": "dokuji001",
  "display": false,
  "productType": 1,
  "productName": "テスト商品",
  "isUpdateProductOrder": false,
  "productDesc": ProductDesc
}
Types

ProductDesc

Description

商品説明

Fields
Input Field Description
pc - ProductDescContent PCでの商品説明
mobile - ProductDescContent スマホでの商品説明
Example
{
  "pc": ProductDescContent,
  "mobile": ProductDescContent
}
Types

ProductDescContent

Description

商品説明の中身

Fields
Input Field Description
content - String 説明
addContent - String 追加説明
Example
{"content": "テスト説明", "addContent": "テスト追加説明"}
Types

ProductGoogleShopping

Description

Googleショッピング情報

Fields
Input Field Description
category - String Google商品カテゴリ
productName - String 商品名
content - String 詳細内容
isbn - String ISBNコード
brandName - String ブランド名
mpn - String MPN（メーカー型番）
sex - Int64

性別

    1. 未指定
    1. 男性
    1. 女性
    1. ユニセックス
ageGroup - Int64

年齢層

    1. 未指定
    1. 大人
    1. 子供
    1. 幼児(2024.08.05追加)
    1. 乳児(2024.08.05追加)
    1. 新生児(2024.08.05追加)
color - String

色

複数指定する場合は「,」で区切る。
size - String

サイズ

複数指定する場合は「,」で区切る。
material - String

素材

複数指定する場合は「,」で区切る。
design - String

柄

複数指定する場合は「,」で区切る。
productGroup - String 商品グループ
adwordsGroup - String 広告グループ
adwordsLabel - String カスタムラベル
Example
{
  "category": "DIY用品 > DIY小物類",
  "productName": "テスト商品名",
  "content": "テスト詳細",
  "isbn": "1234567890123",
  "brandName": "テストブランド",
  "mpn": "test-vi_0009",
  "sex": 1,
  "ageGroup": 1,
  "color": "赤,青,緑,黒",
  "size": "S,M,L,LL,3L",
  "material": "素材1,素材2,素材3",
  "design": "柄1,柄2",
  "productGroup": "test00001",
  "adwordsGroup": "広告１",
  "adwordsLabel": "ラベル１"
}
Types

ProductNameOption

Description

名入れ
指定した名入れの項目数が管理画面の設定と一致してる必要があります。

Fields
Input Field Description
productNameOption1 - String 名入れ内容1
productNameOption2 - String 名入れ内容2
productNameOption3 - String 名入れ内容3
productNameOption4 - String 名入れ内容4
productNameOption5 - String 名入れ内容5
productNameOption6 - String 名入れ内容6
productNameOption7 - String 名入れ内容7
productNameOption8 - String 名入れ内容8
productNameOption9 - String 名入れ内容9
productNameOption10 - String 名入れ内容10
Example
{
  "productNameOption1": "テスト太郎",
  "productNameOption2": "テスト太郎",
  "productNameOption3": "テスト太郎",
  "productNameOption4": "テスト太郎",
  "productNameOption5": "テスト太郎",
  "productNameOption6": "テスト太郎",
  "productNameOption7": "テスト太郎",
  "productNameOption8": "テスト太郎",
  "productNameOption9": "テスト太郎",
  "productNameOption10": "テスト太郎"
}
Types

ProductQuantityRequest

Description

商品在庫情報更新リクエスト詳細

Fields
Input Field Description
systemCode - String! システム商品コード
quantityCalculationType - Uint64!

在庫数の計算方法

  1. 指定した在庫数(quantity)に変更
  2. 指定した個数(quantity)を増減
  3. 無制限にする
quantity - Int64 在庫数
Example
{"systemCode": "000000000007", "quantityCalculationType": 1, "quantity": 1}
Types

ProductSubImage

Description

サブ画像

Fields
Field Name Description
subImageId - Uint64! サブ画像ID
url - String! 画像URL
seq - Uint64! 表示順
Example
{"subImageId": 1, "url": "https:/example.com/image001.png", "seq": 1}
Types

ProductVariationDetail

Description

バリエーション詳細設定
※削除指定されている場合は設定できません。

Fields
Input Field Description
variation1ItemName - String バリエーション1項目名
※新規登録、追加する場合のみ指定可。
※項目名の重複は不可。
※項目名を変更したい場合は、削除してから登録し直してください。
variation1ItemId - Int64 バリエーション1項目ID
※ID指定することで項目名以外を更新可。
variation2ItemName - String バリエーション2項目名
※新規登録、追加する場合のみ指定可。
※項目名の重複は不可。
※項目名を変更したい場合は、削除してから登録し直してください。
variation2ItemId - Int64 バリエーション2項目ID
※ID指定することで項目名以外を更新可。
price - Int64 販売価格
quantityCalculationType - Uint64

在庫数の計算方法

  • 1 : 指定した在庫数(quantity)に変更
  • 2 : 指定した個数(quantity)を増減（商品新規登録時は2を選択できない）
  • 3 : 無制限にする
quantity - Int64 在庫数
variationCustomCode - String バリエーション独自コード
janCode - String JANコード
Example
{
  "variation1ItemName": "L",
  "variation1ItemId": 1,
  "variation2ItemName": "青",
  "variation2ItemId": 1,
  "price": 999,
  "quantityCalculationType": 1,
  "quantity": 999,
  "variationCustomCode": "variationcode001",
  "janCode": "1234567890123"
}
Types

PromotionInfo

Description

販促情報

Fields
Input Field Description
reserve - Int64 ポイント
reserveType - Uint64

ポイント設定

  • 1 : 値
  • 2 : ポイント率
sellStartDatetime - String

掲載期間（開始）

YYYY-MM-DD HH:MM:SS形式
sellEndDatetime - String

掲載期間（終了）

YYYY-MM-DD HH:MM:SS形式
isDisplayOutOfSellPeriod - Boolean

掲載期間外表示可否

  • true : 表示する
  • false : 表示しない
discountRate - Uint64

割引率

割引しない場合は0指定で問題ない。
discountPeriodUnlimited - Boolean

割引期間が無制限

  • true : 無制限
  • false : 無制限でない
discountStart - String

割引期間（開始）

YYYYMMDDHHMM形式
discountEnd - String

割引期間（終了）

YYYYMMDDHHMM形式
Example
{
  "reserve": 1,
  "reserveType": 1,
  "sellStartDatetime": "2024-03-08 00:00:00",
  "sellEndDatetime": "2024-03-08 00:00:00",
  "isDisplayOutOfSellPeriod": false,
  "discountRate": 5,
  "discountPeriodUnlimited": false,
  "discountStart": "202403080000",
  "discountEnd": "202403080000"
}
Types

RepeatSaleInfo

Description

定期購入関連情報

Fields
Input Field Description
cycleId - String お届けサイクル
isRegular - Boolean

通常商品としても販売する

  • false : 販売しない
  • true : 販売する
Example
{"cycleId": "20240305114325", "isRegular": false}
Types

RepeatSaleProduct

Description

定期販売 回数割引

Fields
Input Field Description
formOrdinal - Int64 回数
price - Int64 価格
Example
{"formOrdinal": 1, "price": 10000}
Types

ReservationSaleInfo

Description

予約商品関連情報
※予約商品関連情報を設定する場合は、発売日・発売日備考のどちらかは指定必須です。

Fields
Input Field Description
reservationSaledate - String

発売日

YYYY-MM-DD形式
isRegularAfterSold - Boolean

発売日以降は通常商品にする

  • false : 通常商品にしない
  • true : 通常商品にする
reservationSaledateNote - String 発売日備考
arrivalDate - String

出荷予定日

YYYY-MM-DD形式
reservationSaleNote - String 予約商品備考
Example
{
  "reservationSaledate": "2024-03-08",
  "isRegularAfterSold": false,
  "reservationSaledateNote": "発売日備考テスト",
  "arrivalDate": "2024-03-08",
  "reservationSaleNote": "予約商品備考テスト"
}
Types

SaveMemberPasswordResult

Description

会員パスワード更新の結果情報

Fields
Field Name Description
index - Int64! index情報
memberId - String 会員ID
message - String エラーメッセージ
※失敗した場合のみ設定されます
Example
{"index": 1, "memberId": "000000000001", "message": "エラーメッセージ"}
Types

SaveMemberResult

Description

会員情報更新の結果情報

Fields
Field Name Description
index - Int64! index情報
memberId - String 会員ID
message - String エラーメッセージ
※失敗した場合のみ設定されます
Example
{"index": 1, "memberId": "000000000001", "message": "エラーメッセージ"}
Types

SaveMemberShopPointResult

Description

会員ポイント更新の結果情報

Fields
Field Name Description
index - Int64! index情報
memberId - String 会員ID
shopPoint - MemberShopPoint 更新後のショップポイント情報
※成功した場合のみ設定されます
message - String エラーメッセージ
※失敗した場合のみ設定されます
Example
{
  "index": 1,
  "memberId": "000000000001",
  "shopPoint": MemberShopPoint,
  "message": "エラーメッセージ"
}
Types

SaveProductResult

Description

商品情報登録・更新の結果情報

Fields
Field Name Description
index - Int64! index情報
systemCode - String システム商品コード
※登録が成功、更新時のみ設定。
message - String エラーメッセージ
※登録・更新に失敗した場合のみ設定。
Example
{"index": 1, "systemCode": "000000000001", "message": "在庫の上限を超えています。"}
Types

SearchAccessTagRequest

Description

アクセス解析タグ取得リクエスト

Fields
Input Field Description
page - Uint64 ページ
limit - Uint64 検索上限（max 1000）
Example
{"page": 1, "limit": 1000}
Types

SearchAccessTagResponse

Description

アクセス解析タグ取得レスポンス

Fields
Field Name Description
accessTags - [AccessTag!]! アクセス解析タグ
Example
{"accessTags": [AccessTag]}
Types

SearchAppPaymentRequest

Description

アプリ決済情報取得リクエスト
指定必須のInput Field：-

Fields
Input Field Description
planId - Uint64 プランID
fincodePlanId - String fincodeプランID
アプリのサブスクに利用されるプランを一意とするID
status - PaymentStatus 決済ステータス
salesDateFrom - String

支払日(From)

  • YYYY-MM-DD hh:mm:ss形式
salesDateTo - String

支払日(To)

  • YYYY-MM-DD hh:mm:ss形式
targetPeriodFrom - String

対象期間(From)

  • YYYY-MM-DD hh:mm:ss形式
targetPeriodTo - String

対象期間(To)

  • YYYY-MM-DD hh:mm:ss形式
page - Uint64 ページ
limit - Uint64 検索上限件数
Example
{
  "planId": 1,
  "fincodePlanId": "pl_xxxxxxxxxxxxxxxxxxxxxx",
  "status": "UNPROCESSED",
  "salesDateFrom": "2023-07-01 00:00:00",
  "salesDateTo": "2023-07-30 23:59:59",
  "targetPeriodFrom": "2023-06-01 00:00:00",
  "targetPeriodTo": "2025-06-01 23:59:59",
  "page": 1,
  "limit": 1000
}
Types

SearchAppPaymentResponse

Description

アプリ決済情報レスポンス

Fields
Field Name Description
paymentInfos - [PaymentInfo] アプリ決済情報リスト
searchedCount - Uint64! 決済情報 検索結果件数
page - Uint64! ページ
limit - Uint64! 検索上限
Example
{
  "paymentInfos": [PaymentInfo],
  "searchedCount": 3,
  "page": 1,
  "limit": 1000
}
Types

SearchCouponInfo

Description

クーポン情報

Fields
Field Name Description
code - String クーポンコード
name - String クーポン名
isEnabled - Boolean 状態
isForOnlyMember - Boolean

会員専用フラグ

  • true：会員専用
  • false：誰でも
maximumMemberUsableCount - Uint64 利用回数上限
memberGroupIds - [Int64!] 利用可能な会員グループID
minimumPrice - Uint64 最低利用金額
totalUseCount - Uint64 発行数
usedCount - Uint64 利用数
isTargetProduct - Boolean

対象商品設定フラグ

  • true：対象商品を指定
  • false：対象商品を指定しない
discountType - DiscountType

割引タイプ

  • FIXED_AMOUNT：定額
  • FIXED_RATE：定率
  • FREE_DELIVERY_FEE：送料無料
fixedAmount - Uint64 定額
fixedRate - Uint64 定率
startedAt - String 利用開始日時
endedAt - String 利用終了日時
isCreatedExternally - Boolean 購入アシスト経由で作成されたか
updatedAt - String クーポンの更新日時
Example
{
  "code": "coupon",
  "name": "クーポン",
  "isEnabled": false,
  "isForOnlyMember": false,
  "maximumMemberUsableCount": 100,
  "memberGroupIds": [10, 20],
  "minimumPrice": 100,
  "totalUseCount": 100,
  "usedCount": 100,
  "isTargetProduct": false,
  "discountType": "FIXED_AMOUNT",
  "fixedAmount": 100,
  "fixedRate": 10,
  "startedAt": "2006-01-02 15:04:05",
  "endedAt": "2006-01-02 15:04:05",
  "isCreatedExternally": false,
  "updatedAt": "2006-01-02 15:04:05"
}
Types

SearchCouponProductRequest

Description

クーポン対象商品一覧取得リクエスト
指定必須のInput Field：code　page　limit

Fields
Input Field Description
code - String! クーポンコード（指定必須）
page - Uint64! ページ（指定必須）
limit - Uint64! 検索上限（max 1000）（指定必須）
Example
{"code": "coupon", "page": 1, "limit": 1000}
Types

SearchCouponProductResponse

Description

クーポン対象商品一覧取得レスポンス

Fields
Field Name Description
code - String! クーポンコード
productCodes - [String!]! 対象商品コード一覧
searchedCount - Uint64! 検索結果 件数
page - Uint64! ページ
limit - Uint64! 検索上限
Example
{
  "code": "coupon",
  "productCodes": ["abc123"],
  "searchedCount": 6,
  "page": 1,
  "limit": 1000
}
Types

SearchCouponRequest

Description

クーポン情報取得リクエスト
指定必須のInput Field：page　limit

Fields
Input Field Description
code - String クーポンコード
name - String クーポン名
isEnabled - Boolean

状態

  • true：有効
  • false：無効
isForOnlyMember - Boolean

会員専用フラグ

  • true：会員専用
  • false：誰でも
maximumMemberUsableCount - Uint64 利用回数上限
minimumPriceFrom - Uint64 最低利用金額(From)
minimumPriceTo - Uint64 最低利用金額(To)
totalUseCountFrom - Uint64 発行数(From)
totalUseCountTo - Uint64 発行数(To)
usedCountFrom - Uint64 利用数(From)
usedCountTo - Uint64 利用数(To)
isTargetProduct - Boolean

対象商品設定フラグ

  • true：対象商品を指定
  • false：対象商品を指定しない
discountType - [DiscountType]

割引タイプ

  • FIXED_AMOUNT：定額
  • FIXED_RATE：定率
  • FREE_DELIVERY_FEE：送料無料
fixedAmountFrom - Uint64 定額(From)
fixedAmountTo - Uint64 定額(To)
fixedRateFrom - Uint64 定率(From)
fixedRateTo - Uint64 定率(To)
startedFrom - String 利用開始日時(From)
startedTo - String 利用開始日時(To)
endedFrom - String 利用終了日時(From)
endedTo - String 利用終了日時(To)
isCreatedExternally - Boolean 購入アシスト経由で作成されたか
lastUpdateFrom - String 最終更新日(From)
lastUpdateTo - String 最終更新日(To)
page - Uint64! ページ（指定必須）
limit - Uint64! 検索上限（max 1000）（指定必須）
orderBy - CouponOrderBy

ソートカラム

  • UPDATED_AT: 更新日時
  • STARTED_AT: 開始日時
  • ENDED_AT: 終了日時

※デフォルト：UPDATED_AT. Default = UPDATED_AT
desc - Boolean

ソート順

  • true：降順
  • false：昇順

※デフォルト：false. Default = false
Example
{
  "code": "coupon",
  "name": "クーポン",
  "isEnabled": false,
  "isForOnlyMember": false,
  "maximumMemberUsableCount": 100,
  "minimumPriceFrom": 100,
  "minimumPriceTo": 100,
  "totalUseCountFrom": 100,
  "totalUseCountTo": 100,
  "usedCountFrom": 100,
  "usedCountTo": 100,
  "isTargetProduct": false,
  "discountType": ["FIXED_AMOUNT"],
  "fixedAmountFrom": 100,
  "fixedAmountTo": 100,
  "fixedRateFrom": 10,
  "fixedRateTo": 10,
  "startedFrom": "2006-01-02 15:04:05",
  "startedTo": "2006-01-02 15:04:05",
  "endedFrom": "2006-01-02 15:04:05",
  "endedTo": "2006-01-02 15:04:05",
  "isCreatedExternally": false,
  "lastUpdateFrom": "2006-01-02 15:04:05",
  "lastUpdateTo": "2006-01-02 15:04:05",
  "page": 1,
  "limit": 10,
  "orderBy": "UPDATED_AT",
  "desc": false
}
Types