All in gift アプリ公開 API

株式会社ハックルベリーが提供する All in gift アプリの 公開 GraphQL API です

API Endpoints
https://all-in-gift.huckleberryapps.com/2022-10/graphql
Version

0.0.1

Queries

eGift

Description

eギフトを取得

Response

Returns an EGift

Arguments
Name Description
id - String!
catalogProductCursor - String

Example

Query
query eGift(
  $id: String!,
  $catalogProductCursor: String
) {
  eGift(
    id: $id,
    catalogProductCursor: $catalogProductCursor
  ) {
    id
    shopifyOrderId
    shopId
    receiverPageUrl
    receiverName
    firstName
    lastName
    nickname
    digitalMessage {
      ...DigitalMessageFragment
    }
    lineItems {
      ...LineItemFragment
    }
    expiredAt
    isExpired
    cancelledAt
    shippingAddressUpdatedAt
    options {
      ...OptionsFragment
    }
    catalogs {
      ...CatalogFragment
    }
    productVariantIds
    createdAt
    updatedAt
    hasSpecifiedDelieveryDateProduct
    issueInAdvance
    digitalTicketUsedAt
  }
}
Variables
{
  "id": "xyz789",
  "catalogProductCursor": "xyz789"
}
Response
{
  "data": {
    "eGift": {
      "id": "abc123",
      "shopifyOrderId": "abc123",
      "shopId": "abc123",
      "receiverPageUrl": "abc123",
      "receiverName": "xyz789",
      "firstName": "xyz789",
      "lastName": "abc123",
      "nickname": "xyz789",
      "digitalMessage": DigitalMessage,
      "lineItems": [LineItem],
      "expiredAt": "abc123",
      "isExpired": false,
      "cancelledAt": "abc123",
      "shippingAddressUpdatedAt": "abc123",
      "options": Options,
      "catalogs": [Catalog],
      "productVariantIds": ["xyz789"],
      "createdAt": "xyz789",
      "updatedAt": "abc123",
      "hasSpecifiedDelieveryDateProduct": false,
      "issueInAdvance": true,
      "digitalTicketUsedAt": "xyz789"
    }
  }
}
Queries

order

Description

注文を取得

Response

Returns an Order

Arguments
Name Description
id - String!

Example

Query
query order($id: String!) {
  order(id: $id) {
    eGifts {
      ...EGiftFragment
    }
  }
}
Variables
{"id": "abc123"}
Response
{"data": {"order": {"eGifts": [EGift]}}}
Queries

shop

Description

ショップを取得

Response

Returns a Shop

Arguments
Name Description
id - String!

Example

Query
query shop($id: String!) {
  shop(id: $id) {
    id
    email
    name
    phone
    enableValidityShippingDays
    minValidityShippingDays
    maxValidityShippingDays
    enableShippingSunday
    enableShippingMonday
    enableShippingTuesday
    enableShippingWednesday
    enableShippingThursday
    enableShippingFriday
    enableShippingSaturday
    enableShippingHoliday
    enableShippingTimeToMorning
    enableShippingTimeFrom12to14
    enableShippingTimeFrom14to16
    enableShippingTimeFrom16to18
    enableShippingTimeFrom18to20
    enableShippingTimeFrom18to21
    enableShippingTimeFrom19to21
    enableShippingTimeFrom20to21
    enableAutoCancel
    enableCatalogAutoCancel
    enableMailMagazine
    enableMemberShip
    enablePrivacyPolicy
    privacyPolicyLink
    termsLink
    enableDiscountCode
    discountCodeType
    discountCode
    discountCodeStoreLink
    discountLink
    discountCodeDescription
    enableDisplayRecommendItemLink
    enableDisplayRecommendItem
    recommendItemsTitle
    recommendItemsDescription
    recommendItems {
      ...RecommendItemFragment
    }
    disableShippingDays
    logoImagePath
    customStyle {
      ...CustomStyleFragment
    }
    customHtml {
      ...CustomHtmlFragment
    }
    enableDeliveryDate
    enableDeliveryTime
    enableValidDeliveryDateProductVariant
    enableDeliveryCountries
    enableVariationSelection
    enableComments
    commentsTitle
    enableContactMailAddress
    enableContactPhoneNumber
    discountExpiredAt
    createdAt
    updatedAt
    enableCatalogProductFullDescription
    enableSnsShareInReceiverComplatePage
  }
}
Variables
{"id": "abc123"}
Response
{
  "data": {
    "shop": {
      "id": "xyz789",
      "email": "abc123",
      "name": "abc123",
      "phone": "abc123",
      "enableValidityShippingDays": false,
      "minValidityShippingDays": 987,
      "maxValidityShippingDays": 987,
      "enableShippingSunday": true,
      "enableShippingMonday": false,
      "enableShippingTuesday": false,
      "enableShippingWednesday": false,
      "enableShippingThursday": true,
      "enableShippingFriday": false,
      "enableShippingSaturday": false,
      "enableShippingHoliday": true,
      "enableShippingTimeToMorning": true,
      "enableShippingTimeFrom12to14": false,
      "enableShippingTimeFrom14to16": true,
      "enableShippingTimeFrom16to18": false,
      "enableShippingTimeFrom18to20": false,
      "enableShippingTimeFrom18to21": true,
      "enableShippingTimeFrom19to21": true,
      "enableShippingTimeFrom20to21": true,
      "enableAutoCancel": true,
      "enableCatalogAutoCancel": false,
      "enableMailMagazine": false,
      "enableMemberShip": true,
      "enablePrivacyPolicy": false,
      "privacyPolicyLink": "xyz789",
      "termsLink": "xyz789",
      "enableDiscountCode": true,
      "discountCodeType": "CODE",
      "discountCode": "abc123",
      "discountCodeStoreLink": "abc123",
      "discountLink": "abc123",
      "discountCodeDescription": "abc123",
      "enableDisplayRecommendItemLink": false,
      "enableDisplayRecommendItem": false,
      "recommendItemsTitle": "abc123",
      "recommendItemsDescription": "xyz789",
      "recommendItems": [RecommendItem],
      "disableShippingDays": ["abc123"],
      "logoImagePath": "xyz789",
      "customStyle": CustomStyle,
      "customHtml": CustomHtml,
      "enableDeliveryDate": true,
      "enableDeliveryTime": false,
      "enableValidDeliveryDateProductVariant": true,
      "enableDeliveryCountries": ["abc123"],
      "enableVariationSelection": true,
      "enableComments": false,
      "commentsTitle": "xyz789",
      "enableContactMailAddress": false,
      "enableContactPhoneNumber": true,
      "discountExpiredAt": "abc123",
      "createdAt": "abc123",
      "updatedAt": "abc123",
      "enableCatalogProductFullDescription": true,
      "enableSnsShareInReceiverComplatePage": true
    }
  }
}

Mutations

digitalTicketUpdate

Description

デジタルチケットを利用済みにする

Response

Returns a DigitalTicketUpdate

Arguments
Name Description
input - DigitalTicketInput!

Example

Query
mutation digitalTicketUpdate($input: DigitalTicketInput!) {
  digitalTicketUpdate(input: $input) {
    id
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": DigitalTicketInput}
Response
{
  "data": {
    "digitalTicketUpdate": {
      "id": "abc123",
      "userErrors": [UserError]
    }
  }
}
Mutations

eGiftUpdate

Description

eギフトの更新

Response

Returns an EGiftUpdate

Arguments
Name Description
input - EGiftInput

Example

Query
mutation eGiftUpdate($input: EGiftInput) {
  eGiftUpdate(input: $input) {
    eGift {
      ...EGiftFragment
    }
    userErrors {
      ...UserErrorFragment
    }
  }
}
Variables
{"input": EGiftInput}
Response
{
  "data": {
    "eGiftUpdate": {
      "eGift": EGift,
      "userErrors": [UserError]
    }
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

Catalog

Fields
Field Name Description
id - String!
name - String!
imageSrc - String
quantity - Int!
catalogQuantity - Int!
products - [CatalogProduct!]!
Arguments
cursor - String
cursor - String
Example
{
  "id": "abc123",
  "name": "abc123",
  "imageSrc": "xyz789",
  "quantity": 987,
  "catalogQuantity": 123,
  "products": [CatalogProduct],
  "cursor": "xyz789"
}
Types

CatalogProduct

Fields
Field Name Description
id - String!
title - String
description - String
descriptionHtml - String
imageSrc - String
tracksInventory - Boolean
productVariants - [CatalogProductVariant]
Example
{
  "id": "xyz789",
  "title": "xyz789",
  "description": "xyz789",
  "descriptionHtml": "abc123",
  "imageSrc": "xyz789",
  "tracksInventory": true,
  "productVariants": [CatalogProductVariant]
}
Types

CatalogProductVariant

Fields
Field Name Description
id - String!
inventoryQuantity - Int
inventoryPolicy - InventoryPolicy!
options - [CatalogProductVariantOption!]!
Example
{
  "id": "abc123",
  "inventoryQuantity": 987,
  "inventoryPolicy": "CONTINUE",
  "options": [CatalogProductVariantOption]
}
Types

CatalogProductVariantOption

Fields
Field Name Description
name - String!
value - String!
Example
{
  "name": "abc123",
  "value": "abc123"
}
Types

CustomHtml

Fields
Field Name Description
aboutUpperHtml - String
aboutLowerHtml - String
addressUpperHtml - String
addressLowerHtml - String
confirmHtml - String
thanksHtml - String
Example
{
  "aboutUpperHtml": "abc123",
  "aboutLowerHtml": "xyz789",
  "addressUpperHtml": "abc123",
  "addressLowerHtml": "abc123",
  "confirmHtml": "xyz789",
  "thanksHtml": "xyz789"
}
Types

CustomStyle

Fields
Field Name Description
buttonColorCode - String
buttonColorOpacity - Float!
buttonTextColorCode - String!
buttonTextColorOpacity - Float!
boxColorCode - String
boxColorOpacity - Float!
boxTextColorCode - String!
boxTextColorOpacity - Float!
fontFamily - FontFamily!
fontSize - FontSize!
Example
{
  "buttonColorCode": "xyz789",
  "buttonColorOpacity": 123.45,
  "buttonTextColorCode": "abc123",
  "buttonTextColorOpacity": 987.65,
  "boxColorCode": "xyz789",
  "boxColorOpacity": 987.65,
  "boxTextColorCode": "abc123",
  "boxTextColorOpacity": 123.45,
  "fontFamily": "GOTHIC",
  "fontSize": "SMALL"
}
Types

DeliveryDesignationTime

Values
Enum Value Description

MORNING

FROM12TO14

FROM14TO16

FROM16TO18

FROM18TO20

FROM18TO21

FROM19TO21

FROM20TO21
Example
"MORNING"
Types

DigitalMessage

Fields
Field Name Description
cardSrc - String
message - String
Example
{
  "cardSrc": "abc123",
  "message": "abc123"
}
Types

DigitalTicketInput

Fields
Input Field Description
orderId - String!
shopId - String!
Example
{
  "orderId": "xyz789",
  "shopId": "xyz789"
}
Types

DigitalTicketUpdate

Fields
Field Name Description
id - String!
userErrors - [UserError]
Example
{
  "id": "xyz789",
  "userErrors": [UserError]
}
Types

DiscountCodeType

Values
Enum Value Description

CODE

LINK
Example
"CODE"
Types

EGift

Fields
Field Name Description
id - String!
shopifyOrderId - String!
shopId - String!
receiverPageUrl - String!
receiverName - String
firstName - String
lastName - String
nickname - String
digitalMessage - DigitalMessage
lineItems - [LineItem!]!
expiredAt - String!
isExpired - Boolean!
cancelledAt - String
shippingAddressUpdatedAt - String
options - Options
catalogs - [Catalog]
productVariantIds - [String]
createdAt - String!
updatedAt - String!
hasSpecifiedDelieveryDateProduct - Boolean!
issueInAdvance - Boolean!
digitalTicketUsedAt - String
Example
{
  "id": "abc123",
  "shopifyOrderId": "abc123",
  "shopId": "abc123",
  "receiverPageUrl": "abc123",
  "receiverName": "xyz789",
  "firstName": "xyz789",
  "lastName": "xyz789",
  "nickname": "abc123",
  "digitalMessage": DigitalMessage,
  "lineItems": [LineItem],
  "expiredAt": "abc123",
  "isExpired": true,
  "cancelledAt": "abc123",
  "shippingAddressUpdatedAt": "xyz789",
  "options": Options,
  "catalogs": [Catalog],
  "productVariantIds": ["xyz789"],
  "createdAt": "abc123",
  "updatedAt": "abc123",
  "hasSpecifiedDelieveryDateProduct": false,
  "issueInAdvance": false,
  "digitalTicketUsedAt": "abc123"
}
Types

EGiftInput

Fields
Input Field Description
id - String!
firstName - String!
lastName - String!
company - String
countryCode - String!

ISO 3166-1 alpha-2
zip - String!
provinceCode - String!

ISO 3166-2
provinceName - String
city - String!
address1 - String!
address2 - String
phone - String!
email - String!
enableRegisteredMemberShip - Boolean
enableRegisteredMailMagazine - Boolean
deliveryDesignationYear - String
deliveryDesignationMonth - String
deliveryDesignationDay - String
deliveryDesignationTime - DeliveryDesignationTime
selectedCatalogs - [SelectedCatalog]
options - [Option]
comments - String
isDigitalTicket - Boolean
Example
{
  "id": "xyz789",
  "firstName": "abc123",
  "lastName": "abc123",
  "company": "abc123",
  "countryCode": "xyz789",
  "zip": "xyz789",
  "provinceCode": "abc123",
  "provinceName": "abc123",
  "city": "xyz789",
  "address1": "abc123",
  "address2": "xyz789",
  "phone": "xyz789",
  "email": "xyz789",
  "enableRegisteredMemberShip": false,
  "enableRegisteredMailMagazine": false,
  "deliveryDesignationYear": "abc123",
  "deliveryDesignationMonth": "xyz789",
  "deliveryDesignationDay": "abc123",
  "deliveryDesignationTime": "MORNING",
  "selectedCatalogs": [SelectedCatalog],
  "options": [Option],
  "comments": "xyz789",
  "isDigitalTicket": true
}
Types

EGiftUpdate

Fields
Field Name Description
eGift - EGift
userErrors - [UserError]
Example
{
  "eGift": EGift,
  "userErrors": [UserError]
}
Types

Float

Description

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

Example
123.45
Types

FontFamily

Values
Enum Value Description

GOTHIC

MINCHO
Example
"GOTHIC"
Types

FontSize

Values
Enum Value Description

SMALL

MEDIUM

LARGE
Example
"SMALL"
Types

Image

Fields
Field Name Description
transformedSrc - String
Example
{"transformedSrc": "abc123"}
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
123
Types

InventoryPolicy

Values
Enum Value Description

CONTINUE

DENY
Example
"CONTINUE"
Types

LineItem

Fields
Field Name Description
id - String!
image - Image
name - String
title - String!
quantity - Int
product - Product
options - Options
price - Int!
Example
{
  "id": "abc123",
  "image": Image,
  "name": "xyz789",
  "title": "abc123",
  "quantity": 123,
  "product": Product,
  "options": Options,
  "price": 987
}
Types

Metafield

Fields
Field Name Description
id - String!
key - String!
value - String
Example
{
  "id": "xyz789",
  "key": "xyz789",
  "value": "abc123"
}
Types

Option

Fields
Input Field Description
variantId - String!
quantity - Int!
Example
{"variantId": "abc123", "quantity": 987}
Types

Options

Fields
Field Name Description
noshi - String
noshiWrapType - String
noshiName - String
noshiImageSrc - String
noshiGami - String
omoteGaki - String
wrap - String
wrapImageSrc - String
card - String
cardMessage - String
cardImageSrc - String
handbag - String
handbagImageSrc - String
Example
{
  "noshi": "xyz789",
  "noshiWrapType": "xyz789",
  "noshiName": "abc123",
  "noshiImageSrc": "abc123",
  "noshiGami": "abc123",
  "omoteGaki": "abc123",
  "wrap": "abc123",
  "wrapImageSrc": "xyz789",
  "card": "xyz789",
  "cardMessage": "xyz789",
  "cardImageSrc": "xyz789",
  "handbag": "abc123",
  "handbagImageSrc": "abc123"
}
Types

Order

Fields
Field Name Description
eGifts - [EGift]
Example
{"eGifts": [EGift]}
Types

Product

Fields
Field Name Description
descriptionHtml - String
variants - [ProductVariant]!
options - [ProductOption]
metafields - [Metafield]
displayProductTitle - String
productTitle - String
tracksInventory - Boolean
Example
{
  "descriptionHtml": "abc123",
  "variants": [ProductVariant],
  "options": [ProductOption],
  "metafields": [Metafield],
  "displayProductTitle": "abc123",
  "productTitle": "abc123",
  "tracksInventory": false
}
Types

ProductOption

Fields
Field Name Description
name - String!
values - [String!]!
Example
{
  "name": "abc123",
  "values": ["xyz789"]
}
Types

ProductVariant

Fields
Field Name Description
id - String!
selectedOptions - [SelectedOption]!
price - Int!
image - Image
title - String
inventoryPolicy - String
inventoryQuantity - Int
Example
{
  "id": "abc123",
  "selectedOptions": [SelectedOption],
  "price": 123,
  "image": Image,
  "title": "xyz789",
  "inventoryPolicy": "abc123",
  "inventoryQuantity": 987
}
Types

RecommendItem

Fields
Field Name Description
title - String
image - String
description - String
url - String
Example
{
  "title": "xyz789",
  "image": "xyz789",
  "description": "abc123",
  "url": "abc123"
}
Types

SelectedCatalog

Fields
Input Field Description
id - String!
catalogProductVariants - [SelectedCatalogProductVariant!]!
Example
{
  "id": "xyz789",
  "catalogProductVariants": [
    SelectedCatalogProductVariant
  ]
}
Types

SelectedCatalogProductVariant

Fields
Input Field Description
id - String!
quantity - Int!
Example
{"id": "xyz789", "quantity": 987}
Types

SelectedOption

Fields
Field Name Description
name - String!
value - String!
Example
{
  "name": "xyz789",
  "value": "abc123"
}
Types

Shop

Fields
Field Name Description
id - String!
email - String!
name - String!
phone - String
enableValidityShippingDays - Boolean
minValidityShippingDays - Int
maxValidityShippingDays - Int
enableShippingSunday - Boolean
enableShippingMonday - Boolean
enableShippingTuesday - Boolean
enableShippingWednesday - Boolean
enableShippingThursday - Boolean
enableShippingFriday - Boolean
enableShippingSaturday - Boolean
enableShippingHoliday - Boolean
enableShippingTimeToMorning - Boolean
enableShippingTimeFrom12to14 - Boolean
enableShippingTimeFrom14to16 - Boolean
enableShippingTimeFrom16to18 - Boolean
enableShippingTimeFrom18to20 - Boolean
enableShippingTimeFrom18to21 - Boolean
enableShippingTimeFrom19to21 - Boolean
enableShippingTimeFrom20to21 - Boolean
enableAutoCancel - Boolean
enableCatalogAutoCancel - Boolean
enableMailMagazine - Boolean
enableMemberShip - Boolean
enablePrivacyPolicy - Boolean
privacyPolicyLink - String
termsLink - String
enableDiscountCode - Boolean
discountCodeType - DiscountCodeType
discountCode - String
discountCodeStoreLink - String
discountLink - String
discountCodeDescription - String
enableDisplayRecommendItemLink - Boolean
enableDisplayRecommendItem - Boolean
recommendItemsTitle - String
recommendItemsDescription - String
recommendItems - [RecommendItem]
disableShippingDays - [String]
logoImagePath - String
customStyle - CustomStyle
customHtml - CustomHtml
enableDeliveryDate - Boolean
enableDeliveryTime - Boolean
enableValidDeliveryDateProductVariant - Boolean
enableDeliveryCountries - [String]
enableVariationSelection - Boolean
enableComments - Boolean
commentsTitle - String
enableContactMailAddress - Boolean
enableContactPhoneNumber - Boolean
discountExpiredAt - String
createdAt - String!
updatedAt - String!
enableCatalogProductFullDescription - Boolean
enableSnsShareInReceiverComplatePage - Boolean
Example
{
  "id": "abc123",
  "email": "abc123",
  "name": "xyz789",
  "phone": "abc123",
  "enableValidityShippingDays": true,
  "minValidityShippingDays": 123,
  "maxValidityShippingDays": 123,
  "enableShippingSunday": true,
  "enableShippingMonday": false,
  "enableShippingTuesday": true,
  "enableShippingWednesday": true,
  "enableShippingThursday": false,
  "enableShippingFriday": false,
  "enableShippingSaturday": false,
  "enableShippingHoliday": false,
  "enableShippingTimeToMorning": true,
  "enableShippingTimeFrom12to14": false,
  "enableShippingTimeFrom14to16": false,
  "enableShippingTimeFrom16to18": false,
  "enableShippingTimeFrom18to20": true,
  "enableShippingTimeFrom18to21": false,
  "enableShippingTimeFrom19to21": true,
  "enableShippingTimeFrom20to21": true,
  "enableAutoCancel": true,
  "enableCatalogAutoCancel": false,
  "enableMailMagazine": false,
  "enableMemberShip": false,
  "enablePrivacyPolicy": true,
  "privacyPolicyLink": "xyz789",
  "termsLink": "abc123",
  "enableDiscountCode": true,
  "discountCodeType": "CODE",
  "discountCode": "abc123",
  "discountCodeStoreLink": "xyz789",
  "discountLink": "xyz789",
  "discountCodeDescription": "xyz789",
  "enableDisplayRecommendItemLink": false,
  "enableDisplayRecommendItem": true,
  "recommendItemsTitle": "abc123",
  "recommendItemsDescription": "abc123",
  "recommendItems": [RecommendItem],
  "disableShippingDays": ["xyz789"],
  "logoImagePath": "xyz789",
  "customStyle": CustomStyle,
  "customHtml": CustomHtml,
  "enableDeliveryDate": true,
  "enableDeliveryTime": false,
  "enableValidDeliveryDateProductVariant": true,
  "enableDeliveryCountries": ["abc123"],
  "enableVariationSelection": false,
  "enableComments": true,
  "commentsTitle": "xyz789",
  "enableContactMailAddress": false,
  "enableContactPhoneNumber": true,
  "discountExpiredAt": "abc123",
  "createdAt": "abc123",
  "updatedAt": "xyz789",
  "enableCatalogProductFullDescription": false,
  "enableSnsShareInReceiverComplatePage": false
}
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
"xyz789"
Types

UserError

Fields
Field Name Description
messages - [String!]
Example
{"messages": ["abc123"]}
Documentation by Anvil SpectaQL