APIリファレンス

GraphQL API documentation for makeshop apps developers

Contact

apps developer support

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

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

APIリクエスト

エンドポイント

POST https://アプリ開発申請のお手続き完了メールにて通知しております
APIリクエストには、以下をリクエストヘッダに含めてください。

パラメータ 値 説明
content-type application/json -
authorization Bearer PAT.192a522c36a92af...
※永続トークンの入力例		 永続トークンもしくは一時トークンを入力してください。

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

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

▼取得方法
「アプリ開発申請」「アプリ公開申請」後に発行し通知しております。
x-timestamp 1692613424 Unixtimeを入力してください。
有効期限は1時間となります。

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

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 {
        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

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
    }
    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
      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
          addcode
          amount
          price
          taxRate
          grantedShopPoint
          addToCartDate
          discountRate
        }
      }
      couponInfo {
        couponName
        couponCode
        couponDiscount
      }
    }
    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
        }
        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
      }
      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
              }
            }
          }
        }
      }
    }
    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
          }
        }
      }
    }
    searchedCount
    page
    limit
  }
}
Variables
{"input": SearchProductSubscriptionRequest}
Response
{
  "data": {
    "searchProductSubscription": {
      "productSubscriptions": [SearchProductSubscription],
      "searchedCount": 2,
      "page": 1,
      "limit": 1000
    }
  }
}

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

deleteAccessBodyTag

Description

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

Response

Returns a Void

Arguments
Name Description
input - DeleteAccessTagRequest!

Example

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

deleteAccessHeadTag

Description

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

Response

Returns a Void

Arguments
Name Description
input - DeleteAccessTagRequest!

Example

Query
mutation deleteAccessHeadTag($input: DeleteAccessTagRequest!) {
  deleteAccessHeadTag(input: $input)
}
Variables
{"input": DeleteAccessTagRequest}
Response
{"data": {"deleteAccessHeadTag": 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

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

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

BasketInfo

Description

商品情報

Fields
Field Name Description
productCode - String! 商品コード
productCustomCode - String カスタム商品コード
variationCustomCode - String カスタムオプションコード
productName - String 商品名
variationName - String! オプション情報
variation1ItemId - Int64 バリエーション1項目ID
variation2ItemId - Int64 バリエーション2項目ID
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,
  "addcode": "商品別特殊表示",
  "amount": 1,
  "price": 1000,
  "taxRate": 10,
  "grantedShopPoint": 10,
  "addToCartDate": "20230524",
  "discountRate": "0"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

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 クーポン名
couponCode - String クーポンコード
couponDiscount - Int64 クーポン割引額
Example
{
  "couponName": "1万円以上で500円引き",
  "couponCode": "j6jze4t9n8gzmghxnk40",
  "couponDiscount": "-500"
}
Types

CreateAccessTagRequest

Description

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

Fields
Input Field Description
tag - String! アクセス解析タグ
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

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

DeleteAccessTagRequest

Description

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

Fields
Input Field Description
key - String!

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

許容文字: 英数字とアンダースコア, 下限: 1文字, 上限: 32文字
Example
{"key": "Access_tag_key01"}
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

DiscountDetail

Description

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

Fields
Field Name Description
numberOfDeliveries - Uint64 お届け回数
sellPrice - Uint64 販売価格
Example
{"numberOfDeliveries": 1, "sellPrice": 3000}
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
123.45
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

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

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

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：女性
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 最終更新日時
delFlag - String

削除会員フラグ

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

会員フラグ

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

ロックステータスフラグ

  • Y：ロックしている
  • N：ロックしてない
lockTime - Timestamp ロック日時
lockClearApplyTime - Timestamp ロック解除日時
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"
}
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

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の項目
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
}
Types

OrderPriceInfoPerTaxRate

Description

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

Fields
Field Name 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

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 決済方法名称
Example
{
  "orderSubscriptionId": "TK17668554950967546",
  "orderSubscriptionPayMethodCode": "R",
  "orderSubscriptionPayMethodName": "代金引換"
}
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

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

PlanInfo

Description

プラン情報

Fields
Field Name Description
id - Uint64! プランID
name - String! プラン名
fincodePlanId - String fincodeプランID
Example
{
  "id": 4,
  "name": "SubscriptionPlan",
  "fincodePlanId": "pl_xxxxxxxxxxxxxxxxxxxxxx"
}
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

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

SearchMemberRequest

Description

会員情報取得リクエスト
指定必須のInput Field：page　limit

Fields
Input Field Description
memberId - String 会員ID
groupId - String 会員グループID
groupName - String 会員グループ名
memberName - String 会員氏名
memberNameKana - String 会員カタカナ氏名
email - String メールアドレス
tel - String 電話番号
ageFrom - Uint64 年齢(From)
ageTo - Uint64 年齢(To)
shopPointFrom - Int64 保有ショップポイント(From)
shopPointTo - Int64 保有ショップポイント(To)
shopPointExpireDateFrom - String

保有ショップポイント満了日(From)

  • YYYYMMDD形式
shopPointExpireDateTo - String

保有ショップポイント満了日(To)

  • YYYYMMDD形式
joinDateFrom - String

会員登録日(From)

  • YYYYMMDD形式
joinDateTo - String

会員登録日(To)

  • YYYYMMDD形式
deletedStatusType - String 削除会員取得フラグ
lastUpdateDateFrom - String

最終更新日(From)

  • YYYYMMDD形式
lastUpdateDateTo - String

最終更新日(To)

  • YYYYMMDD形式
sortItem - SortItem ソート項目
sortOrder - SortOrder ソート順
page - Uint64! ページ（指定必須）
limit - Uint64! 検索上限件数（指定必須）
Example
{
  "memberId": "230517000001",
  "groupId": "1",
  "groupName": "ゴールド会員",
  "memberName": "メイク太郎",
  "memberNameKana": "メイクタロウ",
  "email": "info@example.com",
  "tel": "00-0000-0000",
  "ageFrom": 20,
  "ageTo": 30,
  "shopPointFrom": 1000,
  "shopPointTo": 10000,
  "shopPointExpireDateFrom": "20230101",
  "shopPointExpireDateTo": "20240101",
  "joinDateFrom": "20230601",
  "joinDateTo": "20230630",
  "deletedStatusType": "2",
  "lastUpdateDateFrom": "20230601",
  "lastUpdateDateTo": "20230630",
  "sortItem": "MEMBER_ID",
  "sortOrder": "ASC",
  "page": 1,
  "limit": 1000
}
Types

SearchMemberResponse

Description

会員情報取得レスポンス

Fields
Field Name Description
members - [MemberInfo]! 会員情報リスト
searchedCount - Uint64! 検索結果件数
displayRecordFrom - Uint64! 出力行数(開始)
displayRecordTo - Uint64! 出力行数(終了)
page - Uint64! ページ
limit - Uint64! 検索上限
Example
{
  "members": [MemberInfo],
  "searchedCount": 1,
  "displayRecordFrom": 1,
  "displayRecordTo": 1,
  "page": 1,
  "limit": 1000
}
Types

SearchOrderRequest

Description

注文情報取得リクエスト
指定必須のInput Field：page　limit

Fields
Input Field Description
startOrderDate - String

注文日 検索開始日時
※startOrderDate～endOrderDateの指定範囲は最大30日となります。

  • YYYYMMDDhhmmss形式
endOrderDate - String

注文日 検索終了日時

  • YYYYMMDDhhmmss形式
displayOrderNumber - String 表示注文番号
memberId - String 会員ID
payMethodCode - String 決済方法コード
paymentNumber - String 外部決済ID
paymentStatusCode - String 決済状態コード
payMethodStatus - String 決済状態
startPaymentDate - String

入金日 検索開始日

  • YYYYMMDDhhmmss形式
endPaymentDate - String

入金日 検索終了日

  • YYYYMMDDhhmmss形式
senderName - String 注文者名
receiverName - String 受取人名
deliveryStatus - String 配送状態 N:未処理 Y:配送完了 C:キャンセル R:返送
slipNumber - String 配送伝票番号
startDeliveryDate - String

配送完了日 検索開始日時

  • YYYYMMDDhhmmss形式
endDeliveryDate - String

配送完了日 検索終了日時

  • YYYYMMDDhhmmss形式
startDesiredDeliveryDate - String

配送希望日 検索開始日

  • YYYY-MM-DD形式
endDesiredDeliveryDate - String

配送希望日 検索終了日

  • YYYY-MM-DD形式
desiredDeliveryTimezone - String

配送希望時間帯
ショップ様の設定内容によってRequestの値が変わります。

佐川急便5つの時間帯
指定なし/午前中/12:00-14:00/14:00-16:00/16:00-18:00/18:00-21:00

佐川急便6つの時間帯
指定なし/午前中/12:00-14:00/14:00-16:00/16:00-18:00/18:00-20:00/19:00-21:00

ゆうパック用
指定なし/午前中/12:00-14:00/14:00-16:00/16:00-18:00/18:00-20:00/19:00-21:00/20:00-21:00

ヤマト運輸用
指定なし/午前中/14:00-16:00/16:00-18:00/18:00-20:00/19:00-21:00

西濃運輸用
指定なし/午前中/午後
startEstimatedShipmentDate - String

出荷予定日 検索開始日

  • YYYY-MM-DD形式
endEstimatedShipmentDate - String

出荷予定日 検索終了日

  • YYYY-MM-DD形式
modifiedFrom - String

注文更新日時　検索開始日時

  • YYYYMMDDhhmmss形式
modifiedTo - String

注文更新日時　検索終了日時

  • YYYYMMDDhhmmss形式
sortOrder - SortOrder ソート順
page - Uint64! ページ（指定必須）
limit - Uint64! 検索上限（max 1000）（指定必須）
Example
{
  "startOrderDate": "20230601000000",
  "endOrderDate": "20230630000000",
  "displayOrderNumber": "P170000000000000000",
  "memberId": "230101000000",
  "payMethodCode": "B",
  "paymentNumber": "N",
  "paymentStatusCode": null,
  "payMethodStatus": "N",
  "startPaymentDate": "20230601000000",
  "endPaymentDate": "20230630000000",
  "senderName": "メイク太郎",
  "receiverName": "メイク次郎",
  "deliveryStatus": "Y",
  "slipNumber": "12345678912",
  "startDeliveryDate": "20230601000000",
  "endDeliveryDate": "20230630000000",
  "startDesiredDeliveryDate": "2023-07-01",
  "endDesiredDeliveryDate": "2023-07-30",
  "desiredDeliveryTimezone": "12:00-14:00",
  "startEstimatedShipmentDate": "2023-07-01",
  "endEstimatedShipmentDate": "2023-07-30",
  "modifiedFrom": "20230701000000",
  "modifiedTo": "20230730235959",
  "sortOrder": "ASC",
  "page": 1,
  "limit": 1000
}
Types

SearchOrderResponse

Description

注文情報取得レスポンス

Fields
Field Name Description
orders - [SearchedOrder]! 注文情報
searchedCount - Uint64! 検索結果件数
searchedAmount - Uint64! 検索結果合計金額
page - Uint64! ページ
limit - Uint64! 検索上限
Example
{
  "orders": [SearchedOrder],
  "searchedCount": 2,
  "searchedAmount": 4500,
  "page": 1,
  "limit": 1000
}
Types

SearchOrderSubscriptionInfo

Description

定期注文情報

Fields
Field Name Description
orderInfo - SearchOrderSubscriptionOrder 注文情報
delivery - OrderSubscriptionDelivery 配送
orderHistories - [OrderSubscriptionOrderHistory] 注文履歴
Example
{
  "orderInfo": SearchOrderSubscriptionOrder,
  "delivery": OrderSubscriptionDelivery,
  "orderHistories": [OrderSubscriptionOrderHistory]
}
Types

SearchOrderSubscriptionOrder

Description

注文情報

Fields
Field Name Description
subscriptionProduct - OrderSubscriptionProduct 購入商品
orderBasicInfo - OrderSubscriptionOrderBasicInfo 注文基本情報
orderSenderInfo - OrderSubscriptionOrderSenderInfo 注文者情報
Example
{
  "subscriptionProduct": OrderSubscriptionProduct,
  "orderBasicInfo": OrderSubscriptionOrderBasicInfo,
  "orderSenderInfo": OrderSubscriptionOrderSenderInfo
}
Types

SearchOrderSubscriptionRequest

Description

定期注文情報取得リクエスト
指定必須のInput Field：page　limit

Fields
Input Field Description
orderSubscriptionCreatedFrom - String

定期申込日(開始)

  • YYYYMMDD形式
orderSubscriptionCreatedTo - String

定期申込日(終了)

  • YYYYMMDD形式
isCardChecked - IsCardCheck

有効性チェック

  • OK：有効性OK
  • NG：有効性NG
cardCheckedDateFrom - String

有効性チェック(月を指定して絞り込み)（開始）

  • YYYYMM形式
cardCheckedDateTo - String

有効性チェック(月を指定して絞り込み)（終了）

  • YYYYMM形式
ordernumManage - String 注文番号 ※注文番号をカンマ区切りで複数指定することができます。指定できる最大数は100までです。
productName - String 商品名
receiverTel - String 電話番号(受取人) ※ハイフン付き
sender - String 注文者
brandCode - String システム商品コード
memo - String

メモ

  • 検索対象：subscriotionMemo、orderMemo
orderSubscriptionBaseId - String 定期購入ID ※定期購入IDをカンマ区切りで複数指定することができます。指定できる最大数は100までです。
senderMail - String 注文者メールアドレス
payMethod - SearchOrderSubscriptionsPaymentMethod

決済方法

  • ALL：全て
  • BANK_TRANSFET：銀行振込
  • JP_BANK：ゆうちょ銀行
  • REPAY：代金引換
  • PG_CREDIT：PGクレジットカード
  • AA_ATOBARAI：AA後払い.com
  • NP_ATOBRAI：NP後払い
  • EPSILON_CREDIT：イプシロンクレジットカード
  • AMAZON_PAY：Amazon Pay
isActive - SearchOrderSubscriptionsStatus

ステータス

  • ALL：全て
  • ACTIVE：継続中
  • INACTIVE：解約または完了
page - Uint64! ページ（指定必須）
limit - Uint64! 検索上限（指定必須）
Example
{
  "orderSubscriptionCreatedFrom": ":20230601",
  "orderSubscriptionCreatedTo": ":20230630",
  "isCardChecked": "OK",
  "cardCheckedDateFrom": "202306",
  "cardCheckedDateTo": "202506",
  "ordernumManage": "P170000000000000000",
  "productName": "【定期】テスト商品",
  "receiverTel": "00-0000-0000",
  "sender": "メイク太郎",
  "brandCode": "000000000001",
  "memo": "2023/6/1　A商品→B商品に変更",
  "orderSubscriptionBaseId": "TK17000000000000000",
  "senderMail": "info@example.com",
  "payMethod": "BANK_TRANSFER",
  "isActive": "ACTIVE",
  "page": 1,
  "limit": 1000
}
Types

SearchOrderSubscriptionResponse

Description

定期注文情報レスポンス

Fields
Field Name Description
orderSubscriptions - [SearchOrderSubscriptionInfo] 定期注文情報
searchedCount - Uint64! 検索総数
page - Uint64! ページ
limit - Uint64! 検索上限
Example
{
  "orderSubscriptions": [SearchOrderSubscriptionInfo],
  "searchedCount": 2,
  "page": 1,
  "limit": 1000
}
Types

SearchOrderSubscriptionsPaymentMethod

Description

定期注文情報取得　決済方法を示すENUM値

Values
Enum Value Description

BANK_TRANSFER

 銀行振込

JP_BANK

 ゆうちょ銀行

REPAY

 代金引換

PG_CREDIT

 PGクレジットカード

AA_ATOBARAI

 AA後払い.com

NP_ATOBARAI

 NP後払い

EPSILON_CREDIT

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

AMAZON_PAY

 Amazon Pay
Example
"BANK_TRANSFER"
Types

SearchOrderSubscriptionsStatus

Description

定期注文情報取得　ステータスを示すENUM値

Values
Enum Value Description

ACTIVE

 継続中

INACTIVE

 解約または完了
Example
"ACTIVE"
Types

SearchProductQuantityRequest

Description

在庫情報取得リクエスト

Fields
Input Field Description
systemCodes - [String!] システム商品コード
customCodes - [String!] 独自商品コード
lastUpdateFrom - String

最終更新日時（from）

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

最終更新日時（to）

  • YYYY-MM-DD hh:mm:ss形式
page - Uint64! ページ（指定必須）
limit - Uint64! 検索上限（max 1000）（指定必須）
Example
{
  "systemCodes": ["000000000001"],
  "customCodes": ["独自商品コード001"],
  "lastUpdateFrom": "2023-06-01 00:00:00",
  "lastUpdateTo": "2023-06-30 00:00:00",
  "page": 1,
  "limit": 1000
}
Types

SearchProductQuantityResponse

Description

在庫情報レスポンス

Fields
Field Name Description
productQuantities - [SearchedProductQuantity!]! 在庫情報
page - Uint64! ページ
limit - Uint64! 検索上限
Example
{
  "productQuantities": [SearchedProductQuantity],
  "page": 1,
  "limit": 1000
}
Types

SearchProductRequest

Description

商品情報取得リクエスト
指定必須のInput Field：page　limit

Fields
Input Field Description
systemCode - String

システム商品コード

商品UIDを0字づめで12ケタにしたもの。
customCode - String 独自商品コード
categoryCode - String カテゴリーコード
lastUpdateFrom - String

最終更新日時

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

lastUpdateFrom, lastUpdateToのいずれかのみでも検索できる。
lastUpdateTo - String
sortOrder - Uint64

ソート順

出力内容の表示順序を指定する。 未指定の場合は『4（更新日の新しい順）』として処理する。

  • 1 … 価格が安い順
  • 2 … 価格が高い順
  • 3 … 更新日が古い順
  • 4 … 更新日が新しい順（初期値）
page - Uint64! ページ（指定必須）
limit - Uint64! 検索上限（max 1000）（指定必須）
Example
{
  "systemCode": "000000000001",
  "customCode": "独自商品コード001",
  "categoryCode": "ct1",
  "lastUpdateFrom": "2023-06-01 00:00:00",
  "lastUpdateTo": "2023-06-30 00:00:00",
  "sortOrder": 1,
  "page": 1,
  "limit": 1000
}
Types

SearchProductResponse

Description

商品情報取得レスポンス

Fields
Field Name Description
products - [SearchedProduct]! 商品情報 検索結果
searchedCount - Uint64! 検索結果 件数
searchedAmount - Uint64! 検索結果 合計金額
page - Uint64! ページ
limit - Uint64! 検索上限
Example
{
  "products": [SearchedProduct],
  "searchedCount": 6,
  "searchedAmount": 14000,
  "page": 1,
  "limit": 1000
}
Types

SearchProductSubscription

Description

定期購入商品情報 検索結果の明細データ

Fields
Field Name Description
uid - Uint64 商品UID
customCode - String 独自商品コード
systemCode - String システム商品コード
productName - String 商品名
subscriptionPrice - Int64 定期購入販売価格
isDiscountUse - String

回数割引の利用可否

  • Y: 回数割引を利用する
  • N: 回数割引を利用しない
discountDetails - [DiscountDetail] 回数割引情報
cycleDetail - CycleDetail サイクル情報
Example
{
  "uid": 3,
  "customCode": "teiki001",
  "systemCode": "000000000003",
  "productName": "定期購入　購入者指定サイクル",
  "subscriptionPrice": 3000,
  "isDiscountUse": "N",
  "discountDetails": [DiscountDetail],
  "cycleDetail": CycleDetail
}
Types

SearchProductSubscriptionRequest

Description

定期購入商品情報取得リクエスト
指定必須のInput Field：page　limit

Fields
Input Field Description
customCode - String 独自商品コード
systemCode - String システム商品コード
productName - String 商品名
subscriptionPriceMin - Uint64 定期購入販売価格（下限）
subscriptionPriceMax - Uint64 定期購入販売価格（上限）
isDiscountUse - YN

回数割引の利用可否

  • Y: 回数割引を利用する
  • N: 回数割引を利用しない
cycleId - String

お届けサイクルID

  • YYYYMMDDhhmmss形式
cycleName - String お届けサイクル名
cycleDesignate - CycleDesignate

お届けサイクル指定方法

  • USER: 購入者が指定
  • SHOP: ショップが指定
page - Uint64! ページ（指定必須）
limit - Uint64! 検索上限（指定必須）
Example
{
  "customCode": "teiki001",
  "systemCode": "000000000001",
  "productName": "【定期】テスト商品",
  "subscriptionPriceMin": 1000,
  "subscriptionPriceMax": 5000,
  "isDiscountUse": "Y",
  "cycleId": "20230524000000",
  "cycleName": "毎月1日にお届け",
  "cycleDesignate": "USER",
  "page": 1,
  "limit": 1000
}
Types

SearchProductSubscriptionResponse

Description

定期購入商品情報取得レスポンス

Fields
Field Name Description
productSubscriptions - [SearchProductSubscription]! 定期購入商品情報 検索結果
searchedCount - Uint64! 検索結果件数
page - Uint64! ページ
limit - Uint64! 検索上限
Example
{
  "productSubscriptions": [SearchProductSubscription],
  "searchedCount": 2,
  "page": 1,
  "limit": 1000
}
Types

SearchedOrder

Description

注文情報

Fields
Field Name Description
systemOrderNumber - String! システム注文番号
displayOrderNumber - String 表示注文番号
memberId - String! 会員ID
orderDate - String! 注文日時
modified - String! 注文更新日時
sumPrice - Int64 注文合計金額
sumPriceOrg - Int64 注文合計金額（注文合計金額修正前の合計金額）
excludedSumTax - Int64 税抜の場合の合計税額, 税込の場合は0円になる
taxCalculationType - Uint64! 消費税の計算タイプ 1:税込・四捨五入（デフォルト） 2:税抜・四捨五入 3:税込・切り捨て 4:税抜・切り捨て 5:税込・切り上げ 6:税抜・切り上げ
priceInfoPerTaxRate - [OrderPriceInfoPerTaxRate] 税率ごとの価格や税額の情報
memberGroupPoint - Uint64! 会員グループ別追加ポイント数
cashDiscountAmount - Uint64! 現金割引額
reserve - Int64 注文者の使用ポイント
payMethodCode - String 決済方法コード
payMethod - String 決済方法
paymentNumber - String 決済ID
paymentStatusCode - String 決済状態コード
paymentStatus - String

決済状態

  • Y：決済完了・注文完了
  • C：注文キャンセル
  • E：決済失敗・売上失敗・連携失敗など
  • N：上記以外のステータス
paymentFeeType - Uint64! 決済手数料の種類 0:手数料なし 1:代引手数料 2:コンビニ手数料 3:NP後払い手数料 4:後払い.com手数料
paymentFee - Int64! 決済手数料
cashOnDeliveryPayMethod - String 代金引換の決済方法
paymentData - String 決済に関する補助情報
paymentDate - String 入金日時
cardMultiple - Uint64 カード支払い方法
senderCompany - String 注文者法人名
senderCompanyKana - String 注文者法人かな名
senderCompanyDept - String 注文者法人部署名
senderName - String 注文者名
senderNameKana - String 注文者かな名
senderPost - String! 注文者郵便番号
senderPrefecture - String! 注文者住所(都道府県)
senderAddress - String 注文者住所(市区町村・番地など)
senderAddress2 - String! 注文者住所(それ以降)
senderTel - String 注文者電話番号
senderEmergencyTel - String 注文者緊急連絡先
senderEmail - String 注文者Email
delFlag - String 注文不可視フラグ N:デフォルト値 Y:不可視 R:在庫復旧済み
ipAddress - String 注文者のIPアドレス
userAgent - String! WebブラウザのUserAgent
userDeviceType - Uint64 ユーザデバイスタイプ 1:PC 2:モバイル 3:スマートフォン 4:注文一括登録
linkId - String リンクID
ordertemp - String オーダーテンポラリ
message - String 注文備考
orderSubscriptionBaseId - String 定期購入ID
deliveryInfos - [DeliveryInfo]! 配送情報
couponInfo - CouponInfo クーポン情報
Example
{
  "systemOrderNumber": "20230522164110230517000001",
  "displayOrderNumber": "P176657926206489240",
  "memberId": "230517000001",
  "orderDate": "2023-05-2216:41:10",
  "modified": "20230522164110",
  "sumPrice": 2500,
  "sumPriceOrg": 2000,
  "excludedSumTax": 0,
  "taxCalculationType": 1,
  "priceInfoPerTaxRate": [OrderPriceInfoPerTaxRate],
  "memberGroupPoint": 0,
  "cashDiscountAmount": 0,
  "reserve": 0,
  "payMethodCode": "R",
  "payMethod": "代金引換",
  "paymentNumber": "N",
  "paymentStatusCode": null,
  "paymentStatus": "N",
  "paymentFeeType": 1,
  "paymentFee": 500,
  "cashOnDeliveryPayMethod": null,
  "paymentData": "代金引換",
  "paymentDate": "20230601152259",
  "cardMultiple": 0,
  "senderCompany": "○○株式会社",
  "senderCompanyKana": "○○カブシキガイシャ",
  "senderCompanyDept": "○○部署",
  "senderName": "山田太郎",
  "senderNameKana": "ヤマダタロウ",
  "senderPost": "0000000",
  "senderPrefecture": "北海道",
  "senderAddress": "渋谷区",
  "senderAddress2": "○○町1-1-1",
  "senderTel": "00-0000-0000",
  "senderEmergencyTel": null,
  "senderEmail": "info@example.com",
  "delFlag": "N",
  "ipAddress": "192.0.2.1",
  "userAgent": "Mozilla/5.0(WindowsNT10.0;Win64;x64)AppleWebKit/537.36(KHTMLlikeGecko)Chrome/113.0.0.0Safari/537.36Edg/113.0.1774.50",
  "userDeviceType": 1,
  "linkId": null,
  "ordertemp": "5ea28585746b21ee5d4232ab79fb552a",
  "message": "伝達メッセージ:決済画面備考欄用の内容入力||deliveryMethodFixationData|20230522162516:1000:000000000001::500",
  "orderSubscriptionBaseId": "TK17668555983497887",
  "deliveryInfos": [DeliveryInfo],
  "couponInfo": CouponInfo
}
Types

SearchedProduct

Description

商品情報 検索結果の明細データ

Fields
Field Name Description
uid - Uint64 商品UID
systemCode - String 商品システムコード
productName - String 商品名
productGroupCode - String 商品グループコード
productGroupName - String 商品グループ名
consumerPrice - Uint64 定価
sellPrice - Int64 販売価格
buyPrice - Uint64 仕入価格
taxRate - Uint64 販売価格の税率
maker - String 製造元
madeIn - String 原産地
keyword - String 検索語
quantity - Int64

在庫数

  • 0: 品切れ
  • NULL: 無制限
weight - Uint64 重量
maxImage - String 拡大画像 maxImageUrlをご利用ください
maxImageUrl - String 拡大画像URL
minImage - String 普通画像 minImageUrlをご利用ください
minImageUrl - String 普通画像URL
tinyImage - String 縮小画像 tinyImageUrlをご利用ください
tinyImageUrl - String 縮小画像URL
mobileImage - String モバイル画像 mobileImageUrlをご利用ください
mobileImageUrl - String モバイル画像URL
mobileTinyImage - String モバイルサムネイル画像 mobileTinyImageUrlをご利用ください
mobileTinyImageUrl - String モバイルサムネイル画像URL
subImage1 - String 追加商品画像1 subImage1Urlをご利用ください
subImage1Url - String 追加商品画像1URL
subImage2 - String 追加商品画像2 subImage2Urlをご利用ください
subImage2Url - String 追加商品画像2URL
subImage3 - String 追加商品画像3 subImage3Urlをご利用ください
subImage3Url - String 追加商品画像3URL
subImages - [ProductSubImage!]! サブ画像
subImageMbCk1 - Uint64

モバイル用追加商品画像1を作成するフラグ

  • 0: 作成しない
  • 1: 作成する
subImageMbCk2 - Uint64 モバイル用追加商品画像2を作成するフラグ
subImageMbCk3 - Uint64 モバイル用追加商品画像3を作成するフラグ
imageLayout - String 追加商品画像の表示パターン
isGigaPlus - String

ギガプラス10に複数画像を登録しているかどうか

  • Y: 登録している
  • N: 登録していない
displayPosition - String

ショップでの表示位置

  • 0: 無し
  • 1: 新商品
  • 2: スペシャル商品
  • 3: おすすめ商品
  • 4: カテゴリーのおすすめ商品
  • 5: GMOとくとくポイントヘッダー登録商品
summary - String
etcType - String

下記情報を | で連結して持つ

ICON=カンマ区切りのアイコン値,MINIQ=最小注文限度,MAXQ=最大注文限度,ORIGIN=原産地を表示するか否か,inventory_view=在庫数を表示するか否か
addCode - String 商品別特殊表示
reserve - Int64 ポイント数
reserveType - Uint64

ポイント設定

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

商品の割引期間

開始日YYYYMMDDHHMM形式｜終了日YYYYMMDDHHMM形式 00000000: 商品割引を使用しない 99999999: 期間制限なし
discountRate - String

商品の割引率

  • 0: 使用しない
deli - String
customCreatedAt - String 商品の登録日時（更新可能で、表示用などに利用）
updatedAt - String 商品の更新日時
createdAt - String 商品の登録日時
display - String

公開するか否か

  • N: 見せない
  • Y: 見せる
customCode - String 商品の独自コード
deliveryMethodId - String 配送方法ID
pcContent - String PCでの説明文
pcAddContent - String PCでの追加説明
mobileContent - String スマホでの説明文
mobileAddContent - String スマホでの追加説明
categoryContent - String 商品カテゴリーページ用商品説明文
isListCategoryContent - String

商品カテゴリーページ用の商品説明文優先フラグ

  • N: 商品詳細内容（content）を表示する
  • Y: 商品カテゴリーページ用商品説明文を表示する
subContent1 - String 追加商品画像説明文1
subContent2 - String 追加商品画像説明文2
subContent3 - String 追加商品画像説明文3
seoContents - String

SEO設定

以下の内容を｜で連結

  • ブラウザタイトル
  • メタタグKeyword
  • メタタグDescription
  • メタタグAuthor
  • ボディタグ直下メッセージ
gmoPointMultiple - Float GMOとくとくポイント付与率
d2CProductName - String D2C用商品名
partnerProductName - String Googleプロダクトサーチ用製品名
partnerProduct - String Googleプロダクトサーチ用ブランド名
googleCategory - String Googleプロダクトサーチ用カテゴリ名
partnerContent - String Googleプロダクトサーチ用製品説明
janCode - String JANコード
isbn - String Googleショッピング情報：ISBN（国際標準図書番号）
recordNumber - String レコードナンバー（価格.comプラン専用）
mpn - String Googleショッピング情報：製品番号
gender - Int64 Googleショッピング情報：性別（男性or女性）
ageGroup - Int64 Googleショッピング情報：年齢層（大人or子供）
skuGroup - String Googleショッピング情報：商品グループ
color - String Googleショッピング情報：色
size - String Googleショッピング情報：サイズ
material - String Googleショッピング情報：素材
design - String Googleショッピング情報：柄
adwordsGroup - String Googleアドワーズ情報：アドワーズグループ
adwordsLabel - String Googleアドワーズ情報：表示ラベル
makerSaleDate - String メーカー発売日（価格.comプラン専用）
condition - String

新品・中古品

  • new: 新品
  • used: 中古品
  • refurbished: 中古品を改修
repeatSaleType - Uint64

定期購入商品タイプ

  • 1: 通常商品
  • 2: 定期購入商品
  • 3: 通常商品と定期購入商品
isReservationSale - String

予約商品設定

  • N: 予約商品にしない
  • Y: 予約商品にする
isRegularAfterSold - String

予約商品を発売後に通常商品にする設定

  • N: しない
  • Y: する
reservationSaleDate - String 発売日
reservationSaleDateNote - String 発売日備考
arrivalDate - String 出荷予定日
reservationSaleNote - String 予約商品備考
isSellStart - String

掲載期間の開始日時設定

  • Y: 設定する
  • N: 設定しない
isSellEnd - String

掲載期間の終了日時設定

  • Y: 設定する
  • N: 設定しない
isDisplayOutOfSellPeriod - String

掲載期間外の表示可否

  • Y: 表示
  • N: 非表示
searchProductName - String 検索用に変換した商品名
searchKeyword - String 検索用に変換した検索語
searchCustomCode - String 検索用に変換した商品の独自コード
searchMaker - String 検索用に変換した製造元
searchContent - String 検索用に変換した商品詳細内容
sellStartDateTime - String 掲載開始日時
sellEndDateTime - String 掲載終了日時
orderMessage - String 決済時備考
isRestockMail - String 再入荷お知らせメール受付設定
isMemberOnly - String

会員用商品の設定

  • Y: 会員のみ閲覧できる
  • N: 会員・非会員問わず閲覧できる
dmpCategoryUid - String dmp用カテゴリーID登録
insertNameGroup - InsertNameGroup 名入れグループ情報
catalogCode - String カタログコード
option - Option オプション情報
variationShowType - Int64

バリエーションの表示方法

  • 1: 表形式
  • 2: プルダウン
  • 3: SKUレイアウト
variation1Default - Int64 バリエーション1の初期表示ID
variation2Default - Int64 バリエーション2の初期表示ID
variations - [Variation] バリエーション情報
categories - [Category] 商品カテゴリ情報
Example
{
  "uid": 7,
  "systemCode": "000000000007",
  "productName": "テスト商品",
  "productGroupCode": "20230525095136",
  "productGroupName": "関連商品",
  "consumerPrice": 2000,
  "sellPrice": 1000,
  "buyPrice": 300,
  "taxRate": 10,
  "maker": "製造元",
  "madeIn": "原産地",
  "keyword": "サイト内検索キーワード",
  "quantity": 999,
  "weight": 100,
  "maxImage": "000000000007_lTTwxXD.png",
  "maxImageUrl": "https://example.com/000000000007_lTTwxXD.png",
  "minImage": "0000000000072_Oc0uSUs.png",
  "minImageUrl": "https://example.com/0000000000072_Oc0uSUs.png",
  "tinyImage": "0000000000073_xvLwIwi.png",
  "tinyImageUrl": "https://example.com/0000000000073_xvLwIwi.png",
  "mobileImage": null,
  "mobileImageUrl": null,
  "mobileTinyImage": null,
  "mobileTinyImageUrl": null,
  "subImage1": "000000000007_1_f1s93cW.png",
  "subImage1Url": "https://example.com/000000000007_1_f1s93cW.png",
  "subImage2": "000000000007_2_r6IwkLv.png",
  "subImage2Url": "https://example.com/000000000007_2_r6IwkLv.png",
  "subImage3": "000000000007_3_s9VDNFY.png",
  "subImage3Url": "https://example.com/000000000007_3_s9VDNFY.png",
  "subImages": [ProductSubImage],
  "subImageMbCk1": 0,
  "subImageMbCk2": 0,
  "subImageMbCk3": 0,
  "imageLayout": "A",
  "isGigaPlus": "Y",
  "displayPosition": "1",
  "summary": null,
  "etcType": "ICON=16,U|MINIQ=2|MAXQ=10|inventory_view|",
  "addCode": "商品別特殊表示",
  "reserve": 1,
  "reserveType": 2,
  "discountPeriod": "202305100000|202305152359",
  "discountRate": "10",
  "deli": null,
  "customCreatedAt": "20230526151934",
  "updatedAt": "2023-05-2615:28:27",
  "createdAt": "2023-05-2615:04:57",
  "display": "Y",
  "customCode": "独自商品コード001",
  "deliveryMethodId": "20230517170431",
  "pcContent": "<div style=\"text-align: left;\">PC用メイン商品説明文</div>\n",
  "pcAddContent": "<div style=\"text-align: left;\">PC用追加商品説明文</div>\n",
  "mobileContent": "スマホ商品説明文2",
  "mobileAddContent": "スマホ商品説明文1",
  "categoryContent": "商品カテゴリーページ用商品説明文",
  "isListCategoryContent": "Y",
  "subContent1": "追加商品説明文1\n",
  "subContent2": "追加商品説明文2",
  "subContent3": "追加商品説明文3",
  "seoContents": null,
  "gmoPointMultiple": 1,
  "d2CProductName": null,
  "partnerProductName": "Googleショッピング用商品名",
  "partnerProduct": "Googleショッピング用ブランド名",
  "googleCategory": "ファッション・アクセサリー > 衣料品 > スカート > ひざ丈スカート",
  "partnerContent": "Googleショッピング用商品説明",
  "janCode": "JAN001",
  "isbn": "1234567890123",
  "recordNumber": null,
  "mpn": "maker001",
  "gender": 2,
  "ageGroup": 1,
  "skuGroup": "abc123",
  "color": "red",
  "size": "S",
  "material": "ポリエステル",
  "design": "チェック",
  "adwordsGroup": "マーメイドスカート",
  "adwordsLabel": "タイトスカート,マーメイドスカート,ひざ丈スカート",
  "makerSaleDate": null,
  "condition": "new",
  "repeatSaleType": 1,
  "isReservationSale": "N",
  "isRegularAfterSold": "N",
  "reservationSaleDate": "20230605",
  "reservationSaleDateNote": "発売日にお届け予定となります",
  "arrivalDate": "20230604",
  "reservationSaleNote": "次回の販売は未定となります。",
  "isSellStart": "Y",
  "isSellEnd": "Y",
  "isDisplayOutOfSellPeriod": "Y",
  "searchProductName": "テスト商品",
  "searchKeyword": "サイト内検索キーワード",
  "searchCustomCode": "独自商品コード001",
  "searchMaker": "製造元",
  "searchContent": "PC用メイン商品説明文",
  "sellStartDateTime": "2023-05-01 00:00:00",
  "sellEndDateTime": "2023-05-31 00:00:00",
  "orderMessage": "決済画面備考欄用の内容入力",
  "isRestockMail": "N",
  "isMemberOnly": "Y",
  "dmpCategoryUid": null,
  "insertNameGroup": InsertNameGroup,
  "catalogCode": "cata001",
  "option": Option,
  "variationShowType": 3,
  "variation1Default": 0,
  "variation2Default": 0,
  "variations": [Variation],
  "categories": [Category]
}
Types

SearchedProductQuantity

Description

在庫情報 検索結果

Fields
Field Name Description
systemCode - String! システム商品コード
customCode - String 独自商品コード
productName - String! 商品名
quantity - Int64

数量

  • NULL: 無制限
variationQuantities - [SearchedVariationQuantity!]! バリエーション在庫情報 検索結果
Example
{
  "systemCode": "000000000007",
  "customCode": "独自商品コード001",
  "productName": "テスト商品",
  "quantity": 50,
  "variationQuantities": [SearchedVariationQuantity]
}
Types

SearchedVariationQuantity

Description

バリエーション在庫情報 検索結果

Fields
Field Name Description
variation1Item - VariationItem! バリエーション1項目
variation2Item - VariationItem バリエーション2項目
variationQuantity - Int64

数量

  • NULL: 無制限
Example
{
  "variation1Item": VariationItem,
  "variation2Item": VariationItem,
  "variationQuantity": 50
}
Types

SettingAreaShippingFee

Description

地域別配送料の設定

Fields
Field Name Description
areaName - String 地域名
feeByArea - Int64 送付先別の配送料
feeByOrderAmounts - [FeeByOrderAmount] 注文金額別の配送料
feeByWeights - [FeeByWeight] 重量別の配送料
feeByOrderQuantitys - [FeeByOrderQuantity] 注文個数別の配送料
Example
{
  "areaName": "東京(23区内)",
  "feeByArea": 1000,
  "feeByOrderAmounts": [FeeByOrderAmount],
  "feeByWeights": [FeeByWeight],
  "feeByOrderQuantitys": [FeeByOrderQuantity]
}
Types

SettingCashOnDeliveryFee

Description

代金引換の手数料設定

Fields
Field Name Description
minAmount - Int64 注文金額（以上）
maxAmount - Int64 注文金額（未満）
fee - Int64 手数料
Example
{"minAmount": 0, "maxAmount": 10000, "fee": 300}
Types

SettingDeliveryArea

Description

配送エリア設定

Fields
Field Name Description
groupName - String グループ名
areas - Area エリア情報
Example
{"groupName": "離島グループ", "areas": Area}
Types

SettingDeliveryDate

Description

配送日時

Fields
Field Name Description
settingDesiredDeliveryDate - SettingDesiredDeliveryDate 配送希望日の設定
settingDeliveryDays - [SettingDeliveryDay]

お届け日数設定

  • 都道府県別の最短配送可能日の追加日数
settingDeliveryHolidays - [String] 出荷休業日設定
settingDeliveryTime - SettingDeliveryTime

配送時間設定

  • 配送業者の配送時間帯の設定
settingDeliveryAreas - [SettingDeliveryArea]

配送エリア設定

  • 配送エリアの設定
Example
{
  "settingDesiredDeliveryDate": SettingDesiredDeliveryDate,
  "settingDeliveryDays": [SettingDeliveryDay],
  "settingDeliveryHolidays": ["2023-05-27,2023-05-28,2023-06-03"],
  "settingDeliveryTime": SettingDeliveryTime,
  "settingDeliveryAreas": [SettingDeliveryArea]
}
Types

SettingDeliveryDay

Description

お届け日数設定

Fields
Field Name Description
areaName - String 都道府県
leadTimeDays - Int64

リードタイム日数

  • 二桁まで
Example
{"areaName": "北海道", "leadTimeDays": 2}
Types

SettingDeliveryMethod

Description

配送方法

Fields
Field Name Description
settingName - String 配送方法名
settingDisplay - String

ステータス

  • Y:公開
  • N:非公開
settingShippingFee - String

送料無料設定

  • 0：無料
  • 99999999：有料
  • 上記以外の値の場合は、その値以上は送料無料
settingShippingFeeMember - String

会員の送料設定

  • N：有料
  • Y：無料
  • D：値引
shippingFeeMemberDiscount - Int64 会員の送料設定の値引額
settingAreaShippingFees - [SettingAreaShippingFee] 地域別配送料金の設定
cashOnDelivery - CashOnDelivery 代金引換
Example
{
  "settingName": "テスト宅配便",
  "settingDisplay": "Y",
  "settingShippingFee": "0xc000628ae8",
  "settingShippingFeeMember": "N",
  "shippingFeeMemberDiscount": 0,
  "settingAreaShippingFees": [SettingAreaShippingFee],
  "cashOnDelivery": CashOnDelivery
}
Types

SettingDeliveryTime

Description

配送時間設定

Fields
Field Name Description
settingUse - String

使用可否

  • 0：非表示
  • 1：表示（必須入力）
  • 2：表示（任意入力）
timeType - String

時間指定タイプ

  • 1：時間帯指定タイプＡ
  • 2：時間帯指定タイプＢ
  • 3：時間帯指定タイプＣ
  • 4：時間帯指定タイプＤ
  • 5：時間帯指定タイプＥ
Example
{"settingUse": "2", "timeType": "1"}
Types

SettingDesiredDeliveryDate

Description

配送希望日の設定

Fields
Field Name Description
settingDisplay - String

配送希望日の表示可否

  • Y：表示
  • N：非表示
required - String

必須可否

  • Y：必須
  • N：不必須
lowerLimit - String

配送希望の下限

  • -1：設定無し
  • 0〜10：設定日
upperLimit - String

配送希望の上限

  • -1：設定なし
  • 1：1週間後
  • 2：2週間後
  • 3：3週間後
  • 4：1ヶ月
  • 5：2ヶ月後
  • 6：3ヶ月後
initialDisplay - String

配送希望日の初期表示日

  • -1：設定無し
  • 0〜10：設定日
standardTime - String

基準時間

  • 0:00～23:00
Example
{
  "settingDisplay": "Y",
  "required": "N",
  "lowerLimit": "2",
  "upperLimit": "2",
  "initialDisplay": "0",
  "standardTime": "0"
}
Types

SettingFee

Description

決済手数料設定

Fields
Field Name Description
minAmount - Uint64 注文金額（以上）
maxAmount - Uint64 注文金額（未満）
fee - Uint64 手数料
Example
{"minAmount": 0, "maxAmount": 10000, "fee": 300}
Types

SettingKuronekoCreditCardPayment

Description

クロネコ クレカ払い：お支払い方法の設定

Fields
Field Name Description
settingLumpSum - String

一括払いの利用設定

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

分割払いの利用設定

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

リボルビング払いの利用設定

  • Y … 利用する
  • N … 利用しない
Example
{"settingLumpSum": "Y", "settingInstallments": "N", "settingRevolving": "N"}
Types

SettingKuronekoWebCollectCreditCardPayment

Description

クロネコwebコレクト クレジットカードの設定：お支払い方法の設定

Fields
Field Name Description
settingLumpSum - String

一括払いの利用設定

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

分割払いの利用設定

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

リボルビング払いの利用設定

  • Y … 利用する
  • N … 利用しない
Example
{"settingLumpSum": "Y", "settingInstallments": "N", "settingRevolving": "N"}
Types

SettingMemberGroupCashOnDeliveryFee

Description

会員グループ別の代金引換手数料設定

Fields
Field Name Description
memberGroupId - String 会員グループID
settingCashOnDeliveryFees - [SettingCashOnDeliveryFee] 代金引換手数料設定
Example
{
  "memberGroupId": "1",
  "settingCashOnDeliveryFees": [SettingCashOnDeliveryFee]
}
Types

SettingZeusPayment

Description

ZEUS決済：お支払い方法の設定

Fields
Field Name Description
settingLumpSum - String

一括払いの利用設定

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

2回払いの利用設定

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

分割払いの利用設定

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

リボルビング払いの利用設定

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

ボーナス一括払いの利用設定

  • Y … 利用する
  • N … 利用しない
Example
{
  "settingLumpSum": "Y",
  "settingTwo": "N",
  "settingInstallments": "N",
  "settingRevolving": "N",
  "settingBonus": "N"
}
Types

SettlementBank

Description

決済方法の設定：銀行振込

Fields
Field Name Description
settingBank - String

銀行振込の利用設定

  • Y … 利用する
  • N … 利用しない
Example
{"settingBank": "Y"}
Types

SettlementBankPost

Description

決済方法の設定：ゆうちょ銀行

Fields
Field Name Description
settingBankPost - String

ゆうちょ銀行の利用設定

  • Y … 利用する
  • N … 利用しない
Example
{"settingBankPost": "Y"}
Types

SettlementCashOnDelivery

Description

決済方法の設定：代金引換

Fields
Field Name Description
settingCashOnDelivery - String

代金引換の利用設定

  • Y … 利用する
  • N … 利用しない
Example
{"settingCashOnDelivery": "Y"}
Types

SettlementEpsilon

Description

決済方法の設定：イプシロン

Fields
Field Name Description
settingCreditCard - String

クレジットカードの利用設定

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

コンビニ決済の利用設定

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

キャリア決済の利用設定

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

銀行振込（バーチャル口座）の利用設定

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

Amazon Payの利用設定

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

楽天ペイの利用設定

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

Yahoo!ウォレット決済の利用設定

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

PayPal決済の利用設定

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

ネット銀行決済の利用設定

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

GMO後払い決済の利用設定

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

PayPayの利用設定

  • Y … 利用する
  • N … 利用しない
Example
{
  "settingCreditCard": "Y",
  "settingConvenience": "Y",
  "settingCarrier": "Y",
  "settingVirtualBank": "Y",
  "settingAmazonPay": "Y",
  "settingRakuten": "Y",
  "settingYahooWallet": "Y",
  "settingPayPal": "Y",
  "settingNetBank": "Y",
  "settingGmoPayLater": "Y",
  "settingPayPay": "Y"
}
Types

SettlementGmoPg

Description

決済方法の設定：GMOペイメントゲートウェイ

Fields
Field Name Description
settingCreditCard - String

クレジットカードの利用設定

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

コンビニ決済の利用設定

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

リクルートかんたん支払いの利用設定

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

キャリア決済の利用設定

  • Y … 利用する
  • N … 利用しない
Example
{
  "settingCreditCard": "Y",
  "settingConvenience": "Y",
  "settingRecruit": "Y",
  "settingCarrier": "Y"
}
Types

SettlementGmoPs

Description

決済方法の設定：GMOペイメントサービス

Fields
Field Name Description
settingPayLater - String

GMO後払いの利用設定

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

GMO後払い決済手数料設定

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

SettlementLinePay

Description

決済方法の設定：LINE Pay

Fields
Field Name Description
settingLinePay - String

LINE Payの利用設定

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

LINE Payの売上処理の設定

  • 1 … 仮売上・実売上
  • 2 … 即時売上
Example
{"settingLinePay": "Y", "settingSalesProcessing": "1"}
Types

SettlementNp

Description

決済方法の設定：ネットプロテクションズ

Fields
Field Name Description
settingPayLater - String

NP後払いの利用設定

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

NP後払い手数料設定

注文金額下限,注文金額上限,手数料||が複数連結されます。
settingLumpSumPay - String

NP掛け払いの利用設定

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

atoneの利用設定

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

atoneの売上処理の設定

  • 1 … 仮売上・実売上
  • 2 … 即時売上
settingAtoneUpdateOption - String

atoneの金額更新オプションの設定

  • Y … 利用する
  • N … 利用しない
Example
{
  "settingPayLater": "Y",
  "settingPayLaterFee": "0,10000,500||10000,100000,300||100000,9999999,0||",
  "settingLumpSumPay": "Y",
  "settingAtone": "Y",
  "settingSalesProcessing": "Y",
  "settingAtoneUpdateOption": "Y"
}
Types

SettlementPaidPayLater

Description

決済方法の設定：Paid決済（後払い決済）

Fields
Field Name Description
settingPaidPayLater - String

Paid決済（後払い決済）の利用設定

  • Y … 利用する
  • N … 利用しない
Example
{"settingPaidPayLater": "Y"}
Types

SettlementPaidy

Description

決済方法の設定：あと払い（ペイディ）

Fields
Field Name Description
settingPaidy - String

あと払い（ペイディ）の利用設定

  • Y … 利用する
  • N … 利用しない
Example
{"settingPaidy": "Y"}
Types

SettlementPayLaterCom

Description

決済方法の設定：後払い.com

Fields
Field Name Description
settingPayLaterCom - String

後払い.comの利用設定

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

連携方法

  • Y … 自動連携
  • N … 手動連携
settingPayLaterComFees - [SettingFee]

後払い.com決済手数料設定

後払い.com決済手数料を購入者に負担していただく場合の決済手数料設定
Example
{
  "settingPayLaterCom": "Y",
  "settingAutoLink": "Y",
  "settingPayLaterComFees": [SettingFee]
}
Types

SettlementPaygent

Description

決済方法の設定：ペイジェント

Fields
Field Name Description
settingPaygentCreditCard - String

ペイジェントカードの利用設定

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

クレジットカード情報お預かり機能の利用設定

  • Y … 利用する
  • N … 利用しない
Example
{"settingPaygentCreditCard": "Y", "settingCardSave": "Y"}
Types

SettlementSgp

Description

決済方法の設定：SMBC GMO PAYMENT

Fields
Field Name Description
settingCreditCard - String

クレジットカードの利用設定

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

コンビニ決済の利用設定

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

キャリア決済の利用設定

  • Y … 利用する
  • N … 利用しない
Example
{"settingCreditCard": "Y", "settingConvenience": "Y", "settingCarrier": "Y"}
Types

SettlementWebby

Description

決済方法の設定：WeBBy

Fields
Field Name Description
settingWebby - String

WeBByの利用設定

  • Y … 利用する
  • N … 利用しない
Example
{"settingWebby": "Y"}
Types

SettlementYamato

Description

決済方法の設定：ヤマト運輸の設定

Fields
Field Name Description
kuronekoWebCollectCreditCard - KuronekoWebCollectCreditCard クロネコwebコレクト クレジットカードの設定
kuronekoWebCollectConvenience - KuronekoWebCollectConvenience クロネコwebコレクト コンビニ決済の設定
kuronekoCreditCard - KuronekoCreditCard クロネコ クレカ払いの設定
kuronekoPayLater - KuronekoPayLater クロネコ代金後払いの設定
Example
{
  "kuronekoWebCollectCreditCard": KuronekoWebCollectCreditCard,
  "kuronekoWebCollectConvenience": KuronekoWebCollectConvenience,
  "kuronekoCreditCard": KuronekoCreditCard,
  "kuronekoPayLater": KuronekoPayLater
}
Types

SettlementZeus

Description

決済方法の設定：ZEUS決済

Fields
Field Name Description
settingCreditCard - String

ZEUS決済クレジットカードの利用設定

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

ZEUS決済の売上処理の設定

  • 1 … 仮売上・実売上
  • 2 … 即時売上
settingSecure - String

3Dセキュアの利用設定

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

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

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

セキュリティコードによる認証の利用設定

  • Y … 利用する
  • N … 利用しない
Example
{
  "settingCreditCard": "Y",
  "settingPayment": SettingZeusPayment,
  "settingSalesProcessing": "1",
  "settingSecure": "Y",
  "settingCardSave": "Y",
  "settingSecurityCode": "Y"
}
Types

ShopBasic

Description

ショップ基本情報

Fields
Field Name Description
shopId - String! ショップID
shopName - String ショップ名
shopUrl - String ショップURL
shopStaffName - String ショップ担当者名
applicantName - String 申請者名
applicantKana - String 申請者名フリガナ
applicantEmail - String 申請者メールアドレス
applicantTel - String 申請者電話番号
companyType - CompanyType! 事業形態
companyName - String 会社名
companyOwnerName - String 会社代表者
companyPostalAddress - String 会社郵便番号
companyAddress - String 会社住所
settingOriginalDomain - String

独自ドメイン適用設定

  • Y … 独自ドメイン適用中
  • N … MakeShopサブドメイン適用中
settingAlwaysSSL - String

常時SSL利用設定

  • Y … 利用あり
  • N … 利用なし
openCondition - String

ショップ開店状態

  • Y … 開店
  • N … 閉店
googleShoppingEntry - String

Googleショッピングの掲載可否

  • Y … 掲載する
  • N … 掲載しない
googleShoppingShopName - String Googleショッピング用のショップ名
contact - Contact

お問い合わせ先設定

顧客応対に必要な基本情報
companyOverview - CompanyOverview

会社概要

会社概要ページの表示設定
isCreatorMode - YN!

クリエイターモードかどうか

  • Y … クリエイターモード
  • N … ベーシックモード
enddate - String

ショップの契約満了日

  • YYYYMMDD形式
Example
{
  "shopId": "test",
  "shopName": "テストショップ",
  "shopUrl": "https://example.com/",
  "shopStaffName": "テスト担当者/",
  "applicantName": "メイク太郎",
  "applicantKana": "メイクタロウ",
  "applicantEmail": "info@example.com",
  "applicantTel": "03-0000-0000/",
  "companyType": "PERSONAL",
  "companyName": "株式会社○○",
  "companyOwnerName": "メイク太郎",
  "companyPostalAddress": "1508512",
  "companyAddress": "東京都渋谷区桜丘町26-1セルリアンタワー",
  "settingOriginalDomain": "Y",
  "settingAlwaysSSL": "Y",
  "openCondition": "Y",
  "googleShoppingEntry": "Y",
  "googleShoppingShopName": "Googleショッピングテストショップ",
  "contact": Contact,
  "companyOverview": CompanyOverview,
  "isCreatorMode": "Y",
  "enddate": "20230522"
}
Types

ShopDeliveryDateSetting

Description

お届けサイクル情報（ショップが指定）の日付指定の情報

Fields
Field Name Description
intervalMonth - String

間隔(月)

  • EVERY_MONTH: 毎月
  • EVERY_TWO_MONTHS: 2ヶ月ごと
  • EVERY_THREE_MONTHS: 3ヶ月ごと
deliveryDate - Uint64 お届け日
addDeliveryDate - Uint64 追加のお届け日
Example
{"intervalMonth": "EVERY_MONTH", "deliveryDate": 1, "addDeliveryDate": 15}
Types

ShopDeliveryDayOfWeekSetting

Description

お届けサイクル情報（ショップが指定）の曜日指定の情報

Fields
Field Name Description
intervalMonth - String

間隔(月)

  • EVERY_MONTH: 毎月
  • EVERY_TWO_MONTHS: 2ヶ月ごと
  • EVERY_THREE_MONTHS: 3ヶ月ごと
deliveryWeek - String

お届け週

  • EVERY_WEEK: 毎週
  • FIRST_WEEK: 第1週
  • SECOND_WEEK: 第2週
  • THIRD_WEEK: 第3週
  • FOURTH_WEEK: 第4週
deliveryDayOfWeek - String

お届け曜日

  • MONDAY: 月曜
  • TUESDAY: 火曜
  • WEDNESDAY: 水曜
  • THURSDAY: 木曜
  • FRIDAY: 金曜
  • SATURDAY: 土曜
  • SUNDAY: 日曜
Example
{
  "intervalMonth": "EVERY_MONTH",
  "deliveryWeek": "FIRST_WEEK",
  "deliveryDayOfWeek": "MONDAY"
}
Types

ShopDesignateSetting

Description

お届けサイクル情報（ショップが指定）の明細データ

Fields
Field Name Description
maxNumberOfDeliveries - Uint64 最大お届け回数
shopCycleDesignate - String

指定方法

  • INTERVAL: 日付で指定
  • DATE: 曜日で指定
  • WEEK: 間隔で指定
intervalDateSetting - ShopIntervalDateSetting 間隔指定の情報
deliveryDateSetting - ShopDeliveryDateSetting 日付指定の情報
deliveryDayOfWeekSetting - ShopDeliveryDayOfWeekSetting 曜日指定の情報
Example
{
  "maxNumberOfDeliveries": 0,
  "shopCycleDesignate": "INTERVAL",
  "intervalDateSetting": ShopIntervalDateSetting,
  "deliveryDateSetting": ShopDeliveryDateSetting,
  "deliveryDayOfWeekSetting": ShopDeliveryDayOfWeekSetting
}
Types

ShopIntervalDateSetting

Description

お届けサイクル情報（ショップが指定）の間隔指定の情報

Fields
Field Name Description
intervalDate - Uint64 間隔(日)
Example
{"intervalDate": 14}
Types

ShopMember

Description

会員の設定

Fields
Field Name Description
addEntryFields - [MemberAddEntryFields]

追加入力項目

追加入力項目の設定
point - MemberPoint

会員ポイント

会員ポイント機能の設定
Example
{
  "addEntryFields": [MemberAddEntryFields],
  "point": MemberPoint
}
Types

ShopOrder

Description

注文の設定

Fields
Field Name Description
settingTaxIncludedExcluded - String

税込・税抜の設定

  • Y … 商品価格を税抜で表示する
  • N … 商品価格を税込で表示する
settingTaxExcludedFraction - String

小数点以下の端数の設定

  • floor … 切り捨て
  • round … 四捨五入
  • ceil … 切り上げ
orderMinAmount - Int64 注文可能最小金額
settingZeroBuy - String

0円時の購入可否

  • Y … 0円購入できる
  • N … 0円購入できない
settingNonCancelTiming - String

注文キャンセル設定

  • 0 … 配送完了後、注文照会からの注文キャンセルを不可能にする
  • 1 … 入金完了後、注文照会からの注文キャンセルを不可能にする
  • 2 … 注文完了後、注文照会からの注文キャンセルを不可能にする
Example
{
  "settingTaxIncludedExcluded": "Y",
  "settingTaxExcludedFraction": "round",
  "orderMinAmount": 0,
  "settingZeroBuy": "Y",
  "settingNonCancelTiming": "2"
}
Types

ShopSettlement

Description

決済方法の設定

Fields
Field Name Description
bank - SettlementBank 銀行振込
bankPost - SettlementBankPost ゆうちょ銀行
cashOnDelivery - SettlementCashOnDelivery 代金引換
epsilon - SettlementEpsilon イプシロン
gmoPg - SettlementGmoPg GMOペイメントゲートウェイ
gmoPs - SettlementGmoPs GMOペイメントサービス
sgp - SettlementSgp SMBC GMO PAYMENT
np - SettlementNp ネットプロテクションズ
yamato - SettlementYamato

ヤマト運輸の設定

ヤマト運輸の決済方法の設定
linePay - SettlementLinePay LINE Pay
paidy - SettlementPaidy あと払い（ペイディ）
payLaterCom - SettlementPayLaterCom 後払い.com
zeus - SettlementZeus ZEUS決済
paygent - SettlementPaygent ペイジェント
paidPayLater - SettlementPaidPayLater Paid決済（後払い決済）
webby - SettlementWebby WeBBy
Example
{
  "bank": SettlementBank,
  "bankPost": SettlementBankPost,
  "cashOnDelivery": SettlementCashOnDelivery,
  "epsilon": SettlementEpsilon,
  "gmoPg": SettlementGmoPg,
  "gmoPs": SettlementGmoPs,
  "sgp": SettlementSgp,
  "np": SettlementNp,
  "yamato": SettlementYamato,
  "linePay": SettlementLinePay,
  "paidy": SettlementPaidy,
  "payLaterCom": SettlementPayLaterCom,
  "zeus": SettlementZeus,
  "paygent": SettlementPaygent,
  "paidPayLater": SettlementPaidPayLater,
  "webby": SettlementWebby
}
Types

SortItem

Description

会員情報取得ソート項目

Values
Enum Value Description

MEMBER_ID

 会員ID

MEMBER_KANA

 会員カタカナ名

BIRTHDAY

 生年月日

REGIST_DATE

 会員登録日

SHOP_POINT

 保有ショップポイント

SHOP_POINT_EXPIRE_DATE

 保有ショップポイント満了日
Example
"MEMBER_ID"
Types

SortOrder

Description

会員情報取得ソート順

Values
Enum Value Description

ASC

 昇順

DESC

 降順
Example
"ASC"
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"
Types

Time

Example
"10:15:30Z"
Types

Timestamp

Example
1592577642
Types

Uint64

Description

uint64

Example
Uint64
Types

UpdateAccessTagRequest

Description

アクセス解析タグ更新リクエスト

Fields
Input Field Description
tag - String! アクセス解析タグ
key - String!

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

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

UpdateAccessTagResponse

Description

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

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

UpdateProductQuantityFailure

Description

商品本体の在庫情報更新の失敗情報

Fields
Field Name Description
systemCode - String! 商品システムコード
message - String! エラーメッセージ
Example
{
  "systemCode": "xyz789",
  "message": "xyz789"
}
Types

UpdateProductQuantityRequest

Description

商品本体の在庫情報更新リクエスト

Fields
Input Field Description
productQuantities - [ProductQuantityRequest!]!
Example
{"productQuantities": [ProductQuantityRequest]}
Types

UpdateProductQuantityResponse

Description

商品本体の在庫情報更新レスポンス

Fields
Field Name Description
failResult - [UpdateProductQuantityFailure]
Example
{"failResult": [UpdateProductQuantityFailure]}
Types

UpdateVariationQuantityFailure

Description

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

Fields
Field Name Description
systemCode - String! 商品システムコード
variation1ItemId - Int64! バリエーション1項目ID
variation2ItemId - Int64 バリエーション2項目ID
message - String! エラーメッセージ
Example
{
  "systemCode": "xyz789",
  "variation1ItemId": Int64,
  "variation2ItemId": Int64,
  "message": "abc123"
}
Types

UpdateVariationQuantityRequest

Description

バリエーションの在庫情報更新リクエスト

Fields
Input Field Description
variationQuantities - [VariationQuantityRequest!]!
Example
{"variationQuantities": [VariationQuantityRequest]}
Types

UpdateVariationQuantityResponse

Description

バリエーションの在庫情報更新レスポンス

Fields
Field Name Description
failResult - [UpdateVariationQuantityFailure]
Example
{"failResult": [UpdateVariationQuantityFailure]}
Types

UserDeliveryDateSetting

Description

お届けサイクル情報（購入者が指定）の日付指定の情報

Fields
Field Name Description
isEveryMonth - String

毎月

  • Y: 毎月の指定あり
  • N: 毎月の指定なし
isEveryTwoMonths - String

2ヶ月ごと

  • Y: 2ヶ月ごとの指定あり
  • N: 2ヶ月ごとの指定なし
isEveryThreeMonths - String

3ヶ月ごと

  • Y: 3ヶ月ごとの指定あり
  • N: 3ヶ月ごとの指定なし
isMonthTwiceBuy - String

月2回購入

  • Y: 可
  • N: 不可
Example
{
  "isEveryMonth": "Y",
  "isEveryTwoMonths": "Y",
  "isEveryThreeMonths": "Y",
  "isMonthTwiceBuy": "N"
}
Types

UserDeliveryDayOfWeekSetting

Description

お届けサイクル情報（購入者が指定）の曜日指定の情報

Fields
Field Name Description
isEveryMonth - String

毎月

  • Y: 毎月の指定あり
  • N: 毎月の指定なし
isEveryTwoMonths - String

2ヶ月ごと

  • Y: 2ヶ月ごとの指定あり
  • N: 2ヶ月ごとの指定なし
isEveryThreeMonths - String

3ヶ月ごと

  • Y: 3ヶ月ごとの指定あり
  • N: 3ヶ月ごとの指定なし
Example
{"isEveryMonth": "Y", "isEveryTwoMonths": "Y", "isEveryThreeMonths": "Y"}
Types

UserDesignateSetting

Description

お届けサイクル情報（購入者が指定）の明細データ

Fields
Field Name Description
intervalDateSetting - UserIntervalDateSetting 間隔指定の情報
deliveryDateSetting - UserDeliveryDateSetting 日付指定の情報
deliveryDayOfWeekSetting - UserDeliveryDayOfWeekSetting 曜日指定の情報
Example
{
  "intervalDateSetting": UserIntervalDateSetting,
  "deliveryDateSetting": UserDeliveryDateSetting,
  "deliveryDayOfWeekSetting": UserDeliveryDayOfWeekSetting
}
Types

UserIntervalDateSetting

Description

お届けサイクル情報（購入者が指定）の間隔指定の情報

Fields
Field Name Description
intervalDateMin - Uint64 間隔(日)(min)
intervalDateMax - Uint64 間隔(日)(max)
Example
{"intervalDateMin": 15, "intervalDateMax": 30}
Types

Variation

Description

バリエーション情報の明細データ

Fields
Field Name Description
variation1ItemId - Int64 バリエーション1項目ID
variation1ItemName - String バリエーション1項目名
variation1Sort - Int64 バリエーション1ソート番号
variation2ItemId - Int64 バリエーション2項目ID
variation2ItemName - String バリエーション2項目名
variation2Sort - Int64 バリエーション2ソート番号
productSystemCode - String 商品システムコード
variationCustomCode - String カスタムオプションコード
price - Int64

販売価格

  • NULL: 商品の販売価格を使用
quantity - Int64

数量

  • NULL: 無制限
janCode - String JANコード
Example
{
  "variation1ItemId": 1,
  "variation1ItemName": "red",
  "variation1Sort": 1,
  "variation2ItemId": 2,
  "variation2ItemName": "S",
  "variation2Sort": 2,
  "productSystemCode": "000000000007",
  "variationCustomCode": "007opt_red",
  "price": 1100,
  "quantity": 50,
  "janCode": "0071"
}
Types

VariationItem

Description

バリエーション項目

Fields
Field Name Description
id - Int64! 項目ID
name - String! 項目名
Example
{"id": 1, "name": "red"}
Types

VariationQuantityDetail

Description

バリエーション在庫数の指定

Fields
Input Field Description
variation1ItemId - Int64! バリエーション1項目ID
variation2ItemId - Int64 バリエーション2項目ID
quantityCalculationType - Uint64!

在庫数の計算方法

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

VariationQuantityRequest

Description

バリエーションの在庫情報更新リクエスト詳細

Fields
Input Field Description
systemCode - String! 商品システムコード
variationQuantityDetails - [VariationQuantityDetail!]! バリエーション在庫数の指定
Example
{
  "systemCode": "000000000007",
  "variationQuantityDetails": [VariationQuantityDetail]
}
Types

Void

Description

The Void scalar type represents no value being returned

Types

YN

Description

「はい／いいえ」または「Yes／No」等を表すENUM値

Values
Enum Value Description

Y

 「はい」または「Yes」

N

 「いいえ」または「No」
Example
"Y"