Flybox GraphQL API

Complete reference documentation for the Flybox GraphQL API.

Contact

Flybox API Support

API Endpoints

https://api.flybox.com/graphql

Version

1.0.0

Queries

`adminGetBox`

Response

Returns a GetBoxResponse!

Arguments

Name	Description
`getBoxParams` - `GetBoxParams!`

Example

Query

query adminGetBox($getBoxParams: GetBoxParams!) {
  adminGetBox(getBoxParams: $getBoxParams) {
    box {
      ...BoxFragment
    }
  }
}

Variables

{"getBoxParams": GetBoxParams}

Response

{"data": {"adminGetBox": {"box": Box}}}

Queries

`adminGetBoxBySerialNumber`

Response

Returns an AdminGetBoxBySerialNumberResponse!

Arguments

Name	Description
`adminGetBoxBySerialNumberParams` - `AdminGetBoxBySerialNumberParams!`

Example

Query

query adminGetBoxBySerialNumber($adminGetBoxBySerialNumberParams: AdminGetBoxBySerialNumberParams!) {
  adminGetBoxBySerialNumber(adminGetBoxBySerialNumberParams: $adminGetBoxBySerialNumberParams) {
    box {
      ...BoxFragment
    }
    customer {
      ...BoxCustomerFragment
    }
    boxMedias {
      ...BoxMediaFragment
    }
    trackingDetails {
      ...TrackingDetailFragment
    }
    timelineEvents {
      ...BoxHistoryFragment
    }
  }
}

Variables

{
  "adminGetBoxBySerialNumberParams": AdminGetBoxBySerialNumberParams
}

Response

{
  "data": {
    "adminGetBoxBySerialNumber": {
      "box": Box,
      "customer": BoxCustomer,
      "boxMedias": [BoxMedia],
      "trackingDetails": [TrackingDetail],
      "timelineEvents": [BoxHistory]
    }
  }
}

Queries

`adminGetBoxMedias`

Response

Returns a GetBoxMediasResponse!

Arguments

Name	Description
`getBoxMediasParams` - `GetBoxMediasParams!`

Example

Query

query adminGetBoxMedias($getBoxMediasParams: GetBoxMediasParams!) {
  adminGetBoxMedias(getBoxMediasParams: $getBoxMediasParams) {
    boxMedias {
      ...BoxMediaFragment
    }
    total
    page
    limit
  }
}

Variables

{"getBoxMediasParams": GetBoxMediasParams}

Response

{
  "data": {
    "adminGetBoxMedias": {
      "boxMedias": [BoxMedia],
      "total": 987,
      "page": 987,
      "limit": 987
    }
  }
}

Queries

`adminGetBoxes`

Response

Returns a GetBoxesResponse!

Arguments

Name	Description
`adminGetBoxesParams` - `AdminGetBoxesParams!`

Example

Query

query adminGetBoxes($adminGetBoxesParams: AdminGetBoxesParams!) {
  adminGetBoxes(adminGetBoxesParams: $adminGetBoxesParams) {
    boxes {
      ...BoxFragment
    }
    total
    page
    limit
  }
}

Variables

{"adminGetBoxesParams": AdminGetBoxesParams}

Response

{
  "data": {
    "adminGetBoxes": {
      "boxes": [Box],
      "total": 123,
      "page": 123,
      "limit": 987
    }
  }
}

Queries

`adminGetCustomer`

Response

Returns a GetCustomerResponse!

Arguments

Name	Description
`getCustomerParams` - `GetCustomerParams!`

Example

Query

query adminGetCustomer($getCustomerParams: GetCustomerParams!) {
  adminGetCustomer(getCustomerParams: $getCustomerParams) {
    customer {
      ...CustomerFragment
    }
  }
}

Variables

{"getCustomerParams": GetCustomerParams}

Response

{"data": {"adminGetCustomer": {"customer": Customer}}}

Queries

`adminGetCustomerCredits`

Response

Returns a GetCustomerCreditsResponse!

Arguments

Name	Description
`getCustomerCreditsParams` - `GetCustomerCreditsParams!`

Example

Query

query adminGetCustomerCredits($getCustomerCreditsParams: GetCustomerCreditsParams!) {
  adminGetCustomerCredits(getCustomerCreditsParams: $getCustomerCreditsParams) {
    customerCredits {
      ...CustomerCreditFragment
    }
    total
    page
    limit
  }
}

Variables

{"getCustomerCreditsParams": GetCustomerCreditsParams}

Response

{
  "data": {
    "adminGetCustomerCredits": {
      "customerCredits": [CustomerCredit],
      "total": 987,
      "page": 987,
      "limit": 123
    }
  }
}

Queries

`adminGetOrder`

Response

Returns a GetOrderResponse!

Arguments

Name	Description
`getOrderParams` - `GetOrderParams!`

Example

Query

query adminGetOrder($getOrderParams: GetOrderParams!) {
  adminGetOrder(getOrderParams: $getOrderParams) {
    order {
      ...OrderFragment
    }
  }
}

Variables

{"getOrderParams": GetOrderParams}

Response

{"data": {"adminGetOrder": {"order": Order}}}

Queries

`adminGetOrders`

Response

Returns a GetOrdersResponse!

Arguments

Name	Description
`getOrdersParams` - `GetOrdersParams!`

Example

Query

query adminGetOrders($getOrdersParams: GetOrdersParams!) {
  adminGetOrders(getOrdersParams: $getOrdersParams) {
    orders {
      ...OrderFragment
    }
    total
    page
    limit
  }
}

Variables

{"getOrdersParams": GetOrdersParams}

Response

{
  "data": {
    "adminGetOrders": {
      "orders": [Order],
      "total": 123,
      "page": 987,
      "limit": 123
    }
  }
}

Queries

`adminGetProduct`

Response

Returns a GetProductResponse!

Arguments

Name	Description
`getProductParams` - `GetProductParams!`

Example

Query

query adminGetProduct($getProductParams: GetProductParams!) {
  adminGetProduct(getProductParams: $getProductParams) {
    product {
      ...ProductFragment
    }
  }
}

Variables

{"getProductParams": GetProductParams}

Response

{"data": {"adminGetProduct": {"product": Product}}}

Queries

`adminGetProducts`

Response

Returns a GetProductsResponse!

Arguments

Name	Description
`adminGetProductsParams` - `AdminGetProductsParams!`

Example

Query

query adminGetProducts($adminGetProductsParams: AdminGetProductsParams!) {
  adminGetProducts(adminGetProductsParams: $adminGetProductsParams) {
    products {
      ...ProductFragment
    }
    total
    page
    limit
  }
}

Variables

{"adminGetProductsParams": AdminGetProductsParams}

Response

{
  "data": {
    "adminGetProducts": {
      "products": [Product],
      "total": 987,
      "page": 987,
      "limit": 123
    }
  }
}

Queries

`adminGetPurchaseOrderByBoxId`

Response

Returns a GetPurchaseOrderByBoxIdResponse!

Arguments

Name	Description
`getPurchaseOrderByBoxIdParams` - `GetPurchaseOrderByBoxIdParams!`

Example

Query

query adminGetPurchaseOrderByBoxId($getPurchaseOrderByBoxIdParams: GetPurchaseOrderByBoxIdParams!) {
  adminGetPurchaseOrderByBoxId(getPurchaseOrderByBoxIdParams: $getPurchaseOrderByBoxIdParams) {
    order {
      ...OrderFragment
    }
  }
}

Variables

{
  "getPurchaseOrderByBoxIdParams": GetPurchaseOrderByBoxIdParams
}

Response

{
  "data": {
    "adminGetPurchaseOrderByBoxId": {"order": Order}
  }
}

Queries

`adminGetTimeline`

Response

Returns a GetTimelineResponse!

Arguments

Name	Description
`getTimelineParams` - `GetTimelineParams!`

Example

Query

query adminGetTimeline($getTimelineParams: GetTimelineParams!) {
  adminGetTimeline(getTimelineParams: $getTimelineParams) {
    timelineEvents {
      ...BoxHistoryFragment
    }
    total
    page
    limit
  }
}

Variables

{"getTimelineParams": GetTimelineParams}

Response

{
  "data": {
    "adminGetTimeline": {
      "timelineEvents": [BoxHistory],
      "total": 123,
      "page": 987,
      "limit": 987
    }
  }
}

Queries

`adminGetTrackingDetail`

Response

Returns a GetTrackingDetailResponse!

Arguments

Name	Description
`getTrackingDetailParams` - `GetTrackingDetailParams!`

Example

Query

query adminGetTrackingDetail($getTrackingDetailParams: GetTrackingDetailParams!) {
  adminGetTrackingDetail(getTrackingDetailParams: $getTrackingDetailParams) {
    trackingDetail {
      ...TrackingDetailFragment
    }
  }
}

Variables

{"getTrackingDetailParams": GetTrackingDetailParams}

Response

{
  "data": {
    "adminGetTrackingDetail": {
      "trackingDetail": TrackingDetail
    }
  }
}

Queries

`adminGetTrackingDetails`

Response

Returns a GetTrackingDetailsResponse!

Arguments

Name	Description
`getTrackingDetailsParams` - `GetTrackingDetailsParams!`

Example

Query

query adminGetTrackingDetails($getTrackingDetailsParams: GetTrackingDetailsParams!) {
  adminGetTrackingDetails(getTrackingDetailsParams: $getTrackingDetailsParams) {
    trackingDetails {
      ...TrackingDetailFragment
    }
    total
    page
    limit
  }
}

Variables

{"getTrackingDetailsParams": GetTrackingDetailsParams}

Response

{
  "data": {
    "adminGetTrackingDetails": {
      "trackingDetails": [TrackingDetail],
      "total": 987,
      "page": 123,
      "limit": 123
    }
  }
}

Queries

`getActiveShoppingCart`

Description

Retrieves the active shopping cart for a customer or an anonymous user.

Response

Returns a ShoppingCart

Arguments

Name	Description
`getActiveShoppingCartParams` - `GetActiveShoppingCartParams!`

Example

Query

query getActiveShoppingCart($getActiveShoppingCartParams: GetActiveShoppingCartParams!) {
  getActiveShoppingCart(getActiveShoppingCartParams: $getActiveShoppingCartParams) {
    status
    id
    externalId
    anonymousId
    subtotalAmount
    totalAmount
    lineItemList {
      ...ShoppingCartLineItemFragment
    }
    shippingAddress {
      ...ShoppingCartShippingAddressFragment
    }
    discountCoupon {
      ...DiscountCouponResultFragment
    }
    discountAmount
    customer {
      ...ShoppingCartCustomerFragment
    }
    createdAt
    updatedAt
    activeDiscount {
      ...ShoppingCartActiveDiscountFragment
    }
    costs {
      ...ShoppingCartCostFragment
    }
  }
}

Variables

{
  "getActiveShoppingCartParams": GetActiveShoppingCartParams
}

Response

{
  "data": {
    "getActiveShoppingCart": {
      "status": "OPEN",
      "id": 987,
      "externalId": "abc123",
      "anonymousId": "abc123",
      "subtotalAmount": 987,
      "totalAmount": 123,
      "lineItemList": [ShoppingCartLineItem],
      "shippingAddress": ShoppingCartShippingAddress,
      "discountCoupon": DiscountCouponResult,
      "discountAmount": 987,
      "customer": ShoppingCartCustomer,
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03",
      "activeDiscount": ShoppingCartActiveDiscount,
      "costs": ShoppingCartCost
    }
  }
}

Queries

`getAdminUser`

Response

Returns a GetAdminUserResponse!

Arguments

Name	Description
`getAdminUserParams` - `GetAdminUserParams!`

Example

Query

query getAdminUser($getAdminUserParams: GetAdminUserParams!) {
  getAdminUser(getAdminUserParams: $getAdminUserParams) {
    admin {
      ...AdminFragment
    }
  }
}

Variables

{"getAdminUserParams": GetAdminUserParams}

Response

{"data": {"getAdminUser": {"admin": Admin}}}

Queries

`getAdminUsers`

Response

Returns a GetAdminUsersResponse!

Arguments

Name	Description
`getAdminUsersParams` - `GetAdminUsersParams!`

Example

Query

query getAdminUsers($getAdminUsersParams: GetAdminUsersParams!) {
  getAdminUsers(getAdminUsersParams: $getAdminUsersParams) {
    admins {
      ...AdminFragment
    }
    total
    page
    limit
  }
}

Variables

{"getAdminUsersParams": GetAdminUsersParams}

Response

{
  "data": {
    "getAdminUsers": {
      "admins": [Admin],
      "total": 123,
      "page": 987,
      "limit": 987
    }
  }
}

Queries

`getAllPossibleRoles`

Response

Returns [Role]!

Example

Query

query getAllPossibleRoles {
  getAllPossibleRoles {
    code
    description
  }
}

Response

{
  "data": {
    "getAllPossibleRoles": [
      {
        "code": "abc123",
        "description": "abc123"
      }
    ]
  }
}

Queries

`getAllTrackingDetails`

Response

Returns a GetAllTrackingDetailsResponse!

Arguments

Name	Description
`getAllTrackingDetailsParams` - `GetAllTrackingDetailsParams!`

Example

Query

query getAllTrackingDetails($getAllTrackingDetailsParams: GetAllTrackingDetailsParams!) {
  getAllTrackingDetails(getAllTrackingDetailsParams: $getAllTrackingDetailsParams) {
    trackingDetails {
      ...ExtendedTrackingDetailFragment
    }
    total
    page
    limit
  }
}

Variables

{
  "getAllTrackingDetailsParams": GetAllTrackingDetailsParams
}

Response

{
  "data": {
    "getAllTrackingDetails": {
      "trackingDetails": [ExtendedTrackingDetail],
      "total": 987,
      "page": 987,
      "limit": 987
    }
  }
}

Queries

`getApiKey`

Response

Returns a GetApiKeyResponse!

Arguments

Name	Description
`getApiKeyParams` - `GetApiKeyParams!`

Example

Query

query getApiKey($getApiKeyParams: GetApiKeyParams!) {
  getApiKey(getApiKeyParams: $getApiKeyParams) {
    apiKey {
      ...ApiKeyFragment
    }
  }
}

Variables

{"getApiKeyParams": GetApiKeyParams}

Response

{"data": {"getApiKey": {"apiKey": ApiKey}}}

Queries

`getApiKeys`

Response

Returns a GetApiKeysResponse!

Arguments

Name	Description
`getApiKeysParams` - `GetApiKeysParams!`

Example

Query

query getApiKeys($getApiKeysParams: GetApiKeysParams!) {
  getApiKeys(getApiKeysParams: $getApiKeysParams) {
    apiKeys {
      ...ApiKeyFragment
    }
    total
    page
    limit
  }
}

Variables

{"getApiKeysParams": GetApiKeysParams}

Response

{
  "data": {
    "getApiKeys": {
      "apiKeys": [ApiKey],
      "total": 123,
      "page": 987,
      "limit": 123
    }
  }
}

Queries

`getAppConfigurableParameters`

Response

Returns a JSON!

Example

Query

query getAppConfigurableParameters {
  getAppConfigurableParameters
}

Response

{"data": {"getAppConfigurableParameters": {}}}

Queries

`getBarcode`

Response

Returns a GetBarcodeResponse!

Arguments

Name	Description
`getBarcodeParams` - `GetBarcodeParams!`

Example

Query

query getBarcode($getBarcodeParams: GetBarcodeParams!) {
  getBarcode(getBarcodeParams: $getBarcodeParams) {
    barcode {
      ...BarcodeFragment
    }
  }
}

Variables

{"getBarcodeParams": GetBarcodeParams}

Response

{"data": {"getBarcode": {"barcode": Barcode}}}

Queries

`getBarcodeBatch`

Response

Returns a GetBarcodeBatchResponse!

Arguments

Name	Description
`getBarcodeBatchParams` - `GetBarcodeBatchParams!`

Example

Query

query getBarcodeBatch($getBarcodeBatchParams: GetBarcodeBatchParams!) {
  getBarcodeBatch(getBarcodeBatchParams: $getBarcodeBatchParams) {
    barcodeBatch {
      ...BarcodeBatchFragment
    }
  }
}

Variables

{"getBarcodeBatchParams": GetBarcodeBatchParams}

Response

{
  "data": {
    "getBarcodeBatch": {"barcodeBatch": BarcodeBatch}
  }
}

Queries

`getBarcodeBatches`

Response

Returns a GetBarcodeBatchesResponse!

Arguments

Name	Description
`getBarcodeBatchesParams` - `GetBarcodeBatchesParams!`

Example

Query

query getBarcodeBatches($getBarcodeBatchesParams: GetBarcodeBatchesParams!) {
  getBarcodeBatches(getBarcodeBatchesParams: $getBarcodeBatchesParams) {
    barcodeBatches {
      ...BarcodeBatchFragment
    }
    total
    page
    limit
  }
}

Variables

{"getBarcodeBatchesParams": GetBarcodeBatchesParams}

Response

{
  "data": {
    "getBarcodeBatches": {
      "barcodeBatches": [BarcodeBatch],
      "total": 123,
      "page": 987,
      "limit": 987
    }
  }
}

Queries

`getBarcodes`

Response

Returns a GetBarcodesResponse!

Arguments

Name	Description
`getBarcodesParams` - `GetBarcodesParams!`

Example

Query

query getBarcodes($getBarcodesParams: GetBarcodesParams!) {
  getBarcodes(getBarcodesParams: $getBarcodesParams) {
    barcodes {
      ...BarcodeFragment
    }
    total
    page
    limit
  }
}

Variables

{"getBarcodesParams": GetBarcodesParams}

Response

{
  "data": {
    "getBarcodes": {
      "barcodes": [Barcode],
      "total": 987,
      "page": 987,
      "limit": 987
    }
  }
}

Queries

`getBox`

Response

Returns a GetBoxResponse!

Arguments

Name	Description
`getBoxParams` - `GetBoxParams!`

Example

Query

query getBox($getBoxParams: GetBoxParams!) {
  getBox(getBoxParams: $getBoxParams) {
    box {
      ...BoxFragment
    }
  }
}

Variables

{"getBoxParams": GetBoxParams}

Response

{"data": {"getBox": {"box": Box}}}

Queries

`getBoxBySerialNumber`

Response

Returns a GetBoxBySerialNumberResponse!

Arguments

Name	Description
`getBoxBySerialNumberParams` - `GetBoxBySerialNumberParams!`

Example

Query

query getBoxBySerialNumber($getBoxBySerialNumberParams: GetBoxBySerialNumberParams!) {
  getBoxBySerialNumber(getBoxBySerialNumberParams: $getBoxBySerialNumberParams) {
    box {
      ...BoxFragment
    }
  }
}

Variables

{"getBoxBySerialNumberParams": GetBoxBySerialNumberParams}

Response

{"data": {"getBoxBySerialNumber": {"box": Box}}}

Queries

`getBoxMedias`

Response

Returns a GetBoxMediasResponse!

Arguments

Name	Description
`getBoxMediasParams` - `GetBoxMediasParams!`

Example

Query

query getBoxMedias($getBoxMediasParams: GetBoxMediasParams!) {
  getBoxMedias(getBoxMediasParams: $getBoxMediasParams) {
    boxMedias {
      ...BoxMediaFragment
    }
    total
    page
    limit
  }
}

Variables

{"getBoxMediasParams": GetBoxMediasParams}

Response

{
  "data": {
    "getBoxMedias": {
      "boxMedias": [BoxMedia],
      "total": 987,
      "page": 987,
      "limit": 987
    }
  }
}

Queries

`getBoxThumbnails`

Response

Returns a GetBoxThumbnailsResponse!

Example

Query

query getBoxThumbnails {
  getBoxThumbnails {
    boxThumbnails {
      ...BoxThumbnailFragment
    }
  }
}

Response

{
  "data": {
    "getBoxThumbnails": {"boxThumbnails": [BoxThumbnail]}
  }
}

Queries

`getBoxType`

Response

Returns a GetBoxTypeResponse!

Arguments

Name	Description
`getBoxTypeParams` - `GetBoxTypeParams!`

Example

Query

query getBoxType($getBoxTypeParams: GetBoxTypeParams!) {
  getBoxType(getBoxTypeParams: $getBoxTypeParams) {
    boxType {
      ...BoxTypeFragment
    }
  }
}

Variables

{"getBoxTypeParams": GetBoxTypeParams}

Response

{"data": {"getBoxType": {"boxType": BoxType}}}

Queries

`getBoxTypes`

Response

Returns a GetBoxTypesResponse!

Arguments

Name	Description
`getBoxTypesParams` - `GetBoxTypesParams!`

Example

Query

query getBoxTypes($getBoxTypesParams: GetBoxTypesParams!) {
  getBoxTypes(getBoxTypesParams: $getBoxTypesParams) {
    boxTypes {
      ...BoxTypeFragment
    }
    total
    page
    limit
  }
}

Variables

{"getBoxTypesParams": GetBoxTypesParams}

Response

{
  "data": {
    "getBoxTypes": {
      "boxTypes": [BoxType],
      "total": 987,
      "page": 987,
      "limit": 987
    }
  }
}

Queries

`getBoxes`

Response

Returns a GetBoxesResponse!

Arguments

Name	Description
`getBoxesParams` - `GetBoxesParams!`

Example

Query

query getBoxes($getBoxesParams: GetBoxesParams!) {
  getBoxes(getBoxesParams: $getBoxesParams) {
    boxes {
      ...BoxFragment
    }
    total
    page
    limit
  }
}

Variables

{"getBoxesParams": GetBoxesParams}

Response

{
  "data": {
    "getBoxes": {
      "boxes": [Box],
      "total": 987,
      "page": 123,
      "limit": 987
    }
  }
}

Queries

`getBoxesSimplifiedInformationBySerialNumbers`

Response

Returns a GetBoxesSimplifiedInformationBySerialNumbersResponse!

Arguments

Name	Description
`getBoxesSimplifiedInformationBySerialNumbersParams` - `GetBoxesSimplifiedInformationBySerialNumbersParams!`

Example

Query

query getBoxesSimplifiedInformationBySerialNumbers($getBoxesSimplifiedInformationBySerialNumbersParams: GetBoxesSimplifiedInformationBySerialNumbersParams!) {
  getBoxesSimplifiedInformationBySerialNumbers(getBoxesSimplifiedInformationBySerialNumbersParams: $getBoxesSimplifiedInformationBySerialNumbersParams) {
    boxes {
      ...SimplifiedBoxInformationFragment
    }
    total
    page
    limit
  }
}

Variables

{
  "getBoxesSimplifiedInformationBySerialNumbersParams": GetBoxesSimplifiedInformationBySerialNumbersParams
}

Response

{
  "data": {
    "getBoxesSimplifiedInformationBySerialNumbers": {
      "boxes": [SimplifiedBoxInformation],
      "total": 987,
      "page": 987,
      "limit": 123
    }
  }
}

Queries

`getCancellationRequest`

Response

Returns a GetCancellationRequestResponse!

Arguments

Name	Description
`getCancellationRequestParams` - `GetCancellationRequestParams!`

Example

Query

query getCancellationRequest($getCancellationRequestParams: GetCancellationRequestParams!) {
  getCancellationRequest(getCancellationRequestParams: $getCancellationRequestParams) {
    cancellationRequest {
      ...CancellationRequestFragment
    }
  }
}

Variables

{
  "getCancellationRequestParams": GetCancellationRequestParams
}

Response

{
  "data": {
    "getCancellationRequest": {
      "cancellationRequest": CancellationRequest
    }
  }
}

Queries

`getCancellationRequests`

Response

Returns a GetCancellationRequestsResponse!

Arguments

Name	Description
`getCancellationRequestsParams` - `GetCancellationRequestsParams!`

Example

Query

query getCancellationRequests($getCancellationRequestsParams: GetCancellationRequestsParams!) {
  getCancellationRequests(getCancellationRequestsParams: $getCancellationRequestsParams) {
    cancellationRequests {
      ...CancellationRequestFragment
    }
    total
    page
    limit
  }
}

Variables

{
  "getCancellationRequestsParams": GetCancellationRequestsParams
}

Response

{
  "data": {
    "getCancellationRequests": {
      "cancellationRequests": [CancellationRequest],
      "total": 123,
      "page": 987,
      "limit": 987
    }
  }
}

Queries

`getConfigurableParameter`

Response

Returns a GetConfigurableParameterResponse!

Arguments

Name	Description
`getConfigurableParameterParams` - `GetConfigurableParameterParams!`

Example

Query

query getConfigurableParameter($getConfigurableParameterParams: GetConfigurableParameterParams!) {
  getConfigurableParameter(getConfigurableParameterParams: $getConfigurableParameterParams) {
    configurableParameter {
      ...ConfigurableParameterFragment
    }
  }
}

Variables

{
  "getConfigurableParameterParams": GetConfigurableParameterParams
}

Response

{
  "data": {
    "getConfigurableParameter": {
      "configurableParameter": ConfigurableParameter
    }
  }
}

Queries

`getConfigurableParameters`

Response

Returns a GetConfigurableParametersResponse!

Arguments

Name	Description
`getConfigurableParametersParams` - `GetConfigurableParametersParams!`

Example

Query

query getConfigurableParameters($getConfigurableParametersParams: GetConfigurableParametersParams!) {
  getConfigurableParameters(getConfigurableParametersParams: $getConfigurableParametersParams) {
    configurableParameters {
      ...ConfigurableParameterFragment
    }
    total
    page
    limit
  }
}

Variables

{
  "getConfigurableParametersParams": GetConfigurableParametersParams
}

Response

{
  "data": {
    "getConfigurableParameters": {
      "configurableParameters": [ConfigurableParameter],
      "total": 123,
      "page": 987,
      "limit": 123
    }
  }
}

Queries

`getCostToRetrieveBoxes`

Response

Returns a GetCostToRetrieveBoxesResponse!

Arguments

Name	Description
`getCostToRetrieveBoxesParams` - `GetCostToRetrieveBoxesParams!`

Example

Query

query getCostToRetrieveBoxes($getCostToRetrieveBoxesParams: GetCostToRetrieveBoxesParams!) {
  getCostToRetrieveBoxes(getCostToRetrieveBoxesParams: $getCostToRetrieveBoxesParams) {
    items {
      ...GetCostToRetrieveBoxesItemFragment
    }
    subtotalAmount
    discountAmount
    totalAmount
  }
}

Variables

{
  "getCostToRetrieveBoxesParams": GetCostToRetrieveBoxesParams
}

Response

{
  "data": {
    "getCostToRetrieveBoxes": {
      "items": [GetCostToRetrieveBoxesItem],
      "subtotalAmount": 123.45,
      "discountAmount": 123.45,
      "totalAmount": 987.65
    }
  }
}

Queries

`getCustomer`

Response

Returns a GetCustomerResponse!

Arguments

Name	Description
`getCustomerParams` - `GetCustomerParams`

Example

Query

query getCustomer($getCustomerParams: GetCustomerParams) {
  getCustomer(getCustomerParams: $getCustomerParams) {
    customer {
      ...CustomerFragment
    }
  }
}

Variables

{"getCustomerParams": GetCustomerParams}

Response

{"data": {"getCustomer": {"customer": Customer}}}

Queries

`getCustomerCredits`

Response

Returns a GetCustomerCreditsResponse!

Arguments

Name	Description
`getCustomerCreditsParams` - `GetCustomerCreditsParams!`

Example

Query

query getCustomerCredits($getCustomerCreditsParams: GetCustomerCreditsParams!) {
  getCustomerCredits(getCustomerCreditsParams: $getCustomerCreditsParams) {
    customerCredits {
      ...CustomerCreditFragment
    }
    total
    page
    limit
  }
}

Variables

{"getCustomerCreditsParams": GetCustomerCreditsParams}

Response

{
  "data": {
    "getCustomerCredits": {
      "customerCredits": [CustomerCredit],
      "total": 123,
      "page": 123,
      "limit": 987
    }
  }
}

Queries

`getCustomerGroup`

Response

Returns a GetCustomerGroupResponse!

Arguments

Name	Description
`getCustomerGroupParams` - `GetCustomerGroupParams!`

Example

Query

query getCustomerGroup($getCustomerGroupParams: GetCustomerGroupParams!) {
  getCustomerGroup(getCustomerGroupParams: $getCustomerGroupParams) {
    customerGroup {
      ...CustomerGroupFragment
    }
  }
}

Variables

{"getCustomerGroupParams": GetCustomerGroupParams}

Response

{
  "data": {
    "getCustomerGroup": {"customerGroup": CustomerGroup}
  }
}

Queries

`getCustomerGroups`

Response

Returns a GetCustomerGroupsResponse!

Arguments

Name	Description
`getCustomerGroupsParams` - `GetCustomerGroupsParams!`

Example

Query

query getCustomerGroups($getCustomerGroupsParams: GetCustomerGroupsParams!) {
  getCustomerGroups(getCustomerGroupsParams: $getCustomerGroupsParams) {
    customerGroups {
      ...CustomerGroupFragment
    }
    total
    page
    limit
  }
}

Variables

{"getCustomerGroupsParams": GetCustomerGroupsParams}

Response

{
  "data": {
    "getCustomerGroups": {
      "customerGroups": [CustomerGroup],
      "total": 123,
      "page": 987,
      "limit": 123
    }
  }
}

Queries

`getCustomers`

Response

Returns a GetCustomersResponse!

Arguments

Name	Description
`getCustomersParams` - `GetCustomersParams!`

Example

Query

query getCustomers($getCustomersParams: GetCustomersParams!) {
  getCustomers(getCustomersParams: $getCustomersParams) {
    customers {
      ...CustomerFragment
    }
    total
    page
    limit
  }
}

Variables

{"getCustomersParams": GetCustomersParams}

Response

{
  "data": {
    "getCustomers": {
      "customers": [Customer],
      "total": 123,
      "page": 987,
      "limit": 123
    }
  }
}

Queries

`getDiscountCoupon`

Response

Returns a DiscountCouponResult!

Arguments

Name	Description
`getDiscountCouponParams` - `GetDiscountCouponParams!`

Example

Query

query getDiscountCoupon($getDiscountCouponParams: GetDiscountCouponParams!) {
  getDiscountCoupon(getDiscountCouponParams: $getDiscountCouponParams) {
    id
    code
    type
    amount
    limit
    usage
    startDate
    endDate
    createdAt
    updatedAt
    status
    minimumPurchaseAmount
    maximumPurchaseAmount
    isUnlimited
    minimumBoxesAmount
    applyToRecurrentPayments
    firstPurchaseOnly
    usageLimitPerCustomer
    recurringBillingCyclesLimit
  }
}

Variables

{"getDiscountCouponParams": GetDiscountCouponParams}

Response

{
  "data": {
    "getDiscountCoupon": {
      "id": 123,
      "code": "xyz789",
      "type": "abc123",
      "amount": 123.45,
      "limit": 123,
      "usage": 987,
      "startDate": "2007-12-03",
      "endDate": "2007-12-03",
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03",
      "status": "abc123",
      "minimumPurchaseAmount": 123,
      "maximumPurchaseAmount": 123,
      "isUnlimited": true,
      "minimumBoxesAmount": 123,
      "applyToRecurrentPayments": true,
      "firstPurchaseOnly": true,
      "usageLimitPerCustomer": 987,
      "recurringBillingCyclesLimit": 123
    }
  }
}

Queries

`getDiscountCoupons`

Response

Returns a DiscountCouponsResult

Arguments

Name	Description
`getDiscountCouponsParams` - `GetDiscountCouponsParams!`

Example

Query

query getDiscountCoupons($getDiscountCouponsParams: GetDiscountCouponsParams!) {
  getDiscountCoupons(getDiscountCouponsParams: $getDiscountCouponsParams) {
    total
    discountCoupons {
      ...DiscountCouponResultFragment
    }
    page
    limit
  }
}

Variables

{"getDiscountCouponsParams": GetDiscountCouponsParams}

Response

{
  "data": {
    "getDiscountCoupons": {
      "total": 123,
      "discountCoupons": [DiscountCouponResult],
      "page": 987,
      "limit": 987
    }
  }
}

Queries

`getDropOffLocations`

Response

Returns a GetDropOffLocationsResponse!

Arguments

Name	Description
`getDropOffLocationsParams` - `GetDropOffLocationsParams!`

Example

Query

query getDropOffLocations($getDropOffLocationsParams: GetDropOffLocationsParams!) {
  getDropOffLocations(getDropOffLocationsParams: $getDropOffLocationsParams) {
    dropOffLocations {
      ...DropOffLocationFragment
    }
  }
}

Variables

{"getDropOffLocationsParams": GetDropOffLocationsParams}

Response

{
  "data": {
    "getDropOffLocations": {
      "dropOffLocations": [DropOffLocation]
    }
  }
}

Queries

`getMembershipDetails`

Response

Returns a GetMembershipDetailsResponse!

Arguments

Name	Description
`getMembershipDetailsParams` - `GetMembershipDetailsParams!`

Example

Query

query getMembershipDetails($getMembershipDetailsParams: GetMembershipDetailsParams!) {
  getMembershipDetails(getMembershipDetailsParams: $getMembershipDetailsParams) {
    memberSince
    membershipCost
    newMembershipCost
    recurringBillingInMonths
    firstPaymentDate
    lastPaymentDate
    nextPaymentDate
  }
}

Variables

{"getMembershipDetailsParams": GetMembershipDetailsParams}

Response

{
  "data": {
    "getMembershipDetails": {
      "memberSince": "2007-12-03",
      "membershipCost": 987.65,
      "newMembershipCost": 123.45,
      "recurringBillingInMonths": 123,
      "firstPaymentDate": "2007-12-03",
      "lastPaymentDate": "2007-12-03",
      "nextPaymentDate": "2007-12-03"
    }
  }
}

Queries

`getMinimumTransitTimeInDaysToRetrieveBoxes`

Response

Returns a GetMinimumTransitTimeInDaysToRetrieveBoxesResponse!

Arguments

Name	Description
`getMinimumTransitTimeInDaysToRetrieveBoxesParams` - `GetMinimumTransitTimeInDaysToRetrieveBoxesParams!`

Example

Query

query getMinimumTransitTimeInDaysToRetrieveBoxes($getMinimumTransitTimeInDaysToRetrieveBoxesParams: GetMinimumTransitTimeInDaysToRetrieveBoxesParams!) {
  getMinimumTransitTimeInDaysToRetrieveBoxes(getMinimumTransitTimeInDaysToRetrieveBoxesParams: $getMinimumTransitTimeInDaysToRetrieveBoxesParams) {
    minimumTransitTimeInDays
    nextValidDeliveryDate
  }
}

Variables

{
  "getMinimumTransitTimeInDaysToRetrieveBoxesParams": GetMinimumTransitTimeInDaysToRetrieveBoxesParams
}

Response

{
  "data": {
    "getMinimumTransitTimeInDaysToRetrieveBoxes": {
      "minimumTransitTimeInDays": 987,
      "nextValidDeliveryDate": "xyz789"
    }
  }
}

Queries

`getMonthlyStorageError`

Response

Returns a GetMonthlyStorageErrorResponse!

Arguments

Name	Description
`getMonthlyStorageErrorParams` - `GetMonthlyStorageErrorParams!`

Example

Query

query getMonthlyStorageError($getMonthlyStorageErrorParams: GetMonthlyStorageErrorParams!) {
  getMonthlyStorageError(getMonthlyStorageErrorParams: $getMonthlyStorageErrorParams) {
    monthlyStorageError {
      ...MonthlyStorageErrorFragment
    }
  }
}

Variables

{
  "getMonthlyStorageErrorParams": GetMonthlyStorageErrorParams
}

Response

{
  "data": {
    "getMonthlyStorageError": {
      "monthlyStorageError": MonthlyStorageError
    }
  }
}

Queries

`getMonthlyStorageErrors`

Response

Returns a GetMonthlyStorageErrorsResponse!

Arguments

Name	Description
`getMonthlyStorageErrorsParams` - `GetMonthlyStorageErrorsParams!`

Example

Query

query getMonthlyStorageErrors($getMonthlyStorageErrorsParams: GetMonthlyStorageErrorsParams!) {
  getMonthlyStorageErrors(getMonthlyStorageErrorsParams: $getMonthlyStorageErrorsParams) {
    monthlyStorageErrors {
      ...MonthlyStorageErrorFragment
    }
    total
    page
    limit
  }
}

Variables

{
  "getMonthlyStorageErrorsParams": GetMonthlyStorageErrorsParams
}

Response

{
  "data": {
    "getMonthlyStorageErrors": {
      "monthlyStorageErrors": [MonthlyStorageError],
      "total": 123,
      "page": 987,
      "limit": 987
    }
  }
}

Queries

`getNotes`

Response

Returns a GetNotesResponse!

Arguments

Name	Description
`getNotesParams` - `GetNotesParams!`

Example

Query

query getNotes($getNotesParams: GetNotesParams!) {
  getNotes(getNotesParams: $getNotesParams) {
    notes {
      ...NoteFragment
    }
  }
}

Variables

{"getNotesParams": GetNotesParams}

Response

{"data": {"getNotes": {"notes": [Note]}}}

Queries

`getOrder`

Response

Returns a GetOrderResponse!

Arguments

Name	Description
`getOrderParams` - `GetOrderParams!`

Example

Query

query getOrder($getOrderParams: GetOrderParams!) {
  getOrder(getOrderParams: $getOrderParams) {
    order {
      ...OrderFragment
    }
  }
}

Variables

{"getOrderParams": GetOrderParams}

Response

{"data": {"getOrder": {"order": Order}}}

Queries

`getOrderShippingAddressNearestWarehouse`

Response

Returns a GetOrderShippingAddressNearestWarehouseResponse!

Arguments

Name	Description
`getOrderShippingAddressNearestWarehouseParams` - `GetOrderShippingAddressNearestWarehouseParams!`

Example

Query

query getOrderShippingAddressNearestWarehouse($getOrderShippingAddressNearestWarehouseParams: GetOrderShippingAddressNearestWarehouseParams!) {
  getOrderShippingAddressNearestWarehouse(getOrderShippingAddressNearestWarehouseParams: $getOrderShippingAddressNearestWarehouseParams) {
    warehouse {
      ...WarehouseFragment
    }
  }
}

Variables

{
  "getOrderShippingAddressNearestWarehouseParams": GetOrderShippingAddressNearestWarehouseParams
}

Response

{
  "data": {
    "getOrderShippingAddressNearestWarehouse": {
      "warehouse": Warehouse
    }
  }
}

Queries

`getOrders`

Response

Returns a GetOrdersResponse!

Arguments

Name	Description
`getOrdersParams` - `GetOrdersParams!`

Example

Query

query getOrders($getOrdersParams: GetOrdersParams!) {
  getOrders(getOrdersParams: $getOrdersParams) {
    orders {
      ...OrderFragment
    }
    total
    page
    limit
  }
}

Variables

{"getOrdersParams": GetOrdersParams}

Response

{
  "data": {
    "getOrders": {
      "orders": [Order],
      "total": 123,
      "page": 123,
      "limit": 987
    }
  }
}

Queries

`getProduct`

Response

Returns a GetProductResponse!

Arguments

Name	Description
`getProductParams` - `GetProductParams!`

Example

Query

query getProduct($getProductParams: GetProductParams!) {
  getProduct(getProductParams: $getProductParams) {
    product {
      ...ProductFragment
    }
  }
}

Variables

{"getProductParams": GetProductParams}

Response

{"data": {"getProduct": {"product": Product}}}

Queries

`getProducts`

Response

Returns a GetProductsResponse!

Arguments

Name	Description
`getProductsParams` - `GetProductsParams!`

Example

Query

query getProducts($getProductsParams: GetProductsParams!) {
  getProducts(getProductsParams: $getProductsParams) {
    products {
      ...ProductFragment
    }
    total
    page
    limit
  }
}

Variables

{"getProductsParams": GetProductsParams}

Response

{
  "data": {
    "getProducts": {
      "products": [Product],
      "total": 123,
      "page": 123,
      "limit": 987
    }
  }
}

Queries

`getPublicConfigurableParameters`

Response

Returns a GetConfigurableParametersResponse!

Arguments

Name	Description
`getConfigurableParametersParams` - `GetConfigurableParametersParams!`

Example

Query

query getPublicConfigurableParameters($getConfigurableParametersParams: GetConfigurableParametersParams!) {
  getPublicConfigurableParameters(getConfigurableParametersParams: $getConfigurableParametersParams) {
    configurableParameters {
      ...ConfigurableParameterFragment
    }
    total
    page
    limit
  }
}

Variables

{
  "getConfigurableParametersParams": GetConfigurableParametersParams
}

Response

{
  "data": {
    "getPublicConfigurableParameters": {
      "configurableParameters": [ConfigurableParameter],
      "total": 987,
      "page": 987,
      "limit": 987
    }
  }
}

Queries

`getPurchaseOrderByBoxId`

Response

Returns a GetPurchaseOrderByBoxIdResponse!

Arguments

Name	Description
`getPurchaseOrderByBoxIdParams` - `GetPurchaseOrderByBoxIdParams!`

Example

Query

query getPurchaseOrderByBoxId($getPurchaseOrderByBoxIdParams: GetPurchaseOrderByBoxIdParams!) {
  getPurchaseOrderByBoxId(getPurchaseOrderByBoxIdParams: $getPurchaseOrderByBoxIdParams) {
    order {
      ...OrderFragment
    }
  }
}

Variables

{
  "getPurchaseOrderByBoxIdParams": GetPurchaseOrderByBoxIdParams
}

Response

{"data": {"getPurchaseOrderByBoxId": {"order": Order}}}

Queries

`getRecommendedWarehouseSpot`

Response

Returns a GetRecommendedWarehouseSpotResponse!

Arguments

Name	Description
`getRecommendedWarehouseSpotParams` - `GetRecommendedWarehouseSpotParams!`

Example

Query

query getRecommendedWarehouseSpot($getRecommendedWarehouseSpotParams: GetRecommendedWarehouseSpotParams!) {
  getRecommendedWarehouseSpot(getRecommendedWarehouseSpotParams: $getRecommendedWarehouseSpotParams) {
    warehouseSpot {
      ...WarehouseSpotFragment
    }
  }
}

Variables

{
  "getRecommendedWarehouseSpotParams": GetRecommendedWarehouseSpotParams
}

Response

{
  "data": {
    "getRecommendedWarehouseSpot": {
      "warehouseSpot": WarehouseSpot
    }
  }
}

Queries

`getReturnLabels`

Response

Returns a GetReturnLabelsResponse!

Arguments

Name	Description
`getReturnLabelsParams` - `GetReturnLabelsParams!`

Example

Query

query getReturnLabels($getReturnLabelsParams: GetReturnLabelsParams!) {
  getReturnLabels(getReturnLabelsParams: $getReturnLabelsParams) {
    returnLabels {
      ...ReturnLabelFragment
    }
    total
    page
    limit
  }
}

Variables

{"getReturnLabelsParams": GetReturnLabelsParams}

Response

{
  "data": {
    "getReturnLabels": {
      "returnLabels": [ReturnLabel],
      "total": 987,
      "page": 123,
      "limit": 123
    }
  }
}

Queries

`getShoppingCart`

Description

Retrieves a shopping cart by its ID or anonymous ID.

Response

Returns a ShoppingCart

Arguments

Name	Description
`getShoppingCartParams` - `GetShoppingCartParams!`

Example

Query

query getShoppingCart($getShoppingCartParams: GetShoppingCartParams!) {
  getShoppingCart(getShoppingCartParams: $getShoppingCartParams) {
    status
    id
    externalId
    anonymousId
    subtotalAmount
    totalAmount
    lineItemList {
      ...ShoppingCartLineItemFragment
    }
    shippingAddress {
      ...ShoppingCartShippingAddressFragment
    }
    discountCoupon {
      ...DiscountCouponResultFragment
    }
    discountAmount
    customer {
      ...ShoppingCartCustomerFragment
    }
    createdAt
    updatedAt
    activeDiscount {
      ...ShoppingCartActiveDiscountFragment
    }
    costs {
      ...ShoppingCartCostFragment
    }
  }
}

Variables

{"getShoppingCartParams": GetShoppingCartParams}

Response

{
  "data": {
    "getShoppingCart": {
      "status": "OPEN",
      "id": 987,
      "externalId": "xyz789",
      "anonymousId": "abc123",
      "subtotalAmount": 123,
      "totalAmount": 987,
      "lineItemList": [ShoppingCartLineItem],
      "shippingAddress": ShoppingCartShippingAddress,
      "discountCoupon": DiscountCouponResult,
      "discountAmount": 123,
      "customer": ShoppingCartCustomer,
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03",
      "activeDiscount": ShoppingCartActiveDiscount,
      "costs": ShoppingCartCost
    }
  }
}

Queries

`getStatistics`

Response

Returns a GetStatisticsResponse!

Arguments

Name	Description
`getStatisticsParams` - `GetStatisticsParams!`

Example

Query

query getStatistics($getStatisticsParams: GetStatisticsParams!) {
  getStatistics(getStatisticsParams: $getStatisticsParams) {
    orders {
      ...OrderStatisticsFragment
    }
    renewals {
      ...OrderStatisticsFragment
    }
    retrievals {
      ...OrderStatisticsFragment
    }
    customers {
      ...CustomerStatisticsFragment
    }
    boxes {
      ...BoxStatisticsFragment
    }
  }
}

Variables

{"getStatisticsParams": GetStatisticsParams}

Response

{
  "data": {
    "getStatistics": {
      "orders": OrderStatistics,
      "renewals": OrderStatistics,
      "retrievals": OrderStatistics,
      "customers": CustomerStatistics,
      "boxes": BoxStatistics
    }
  }
}

Queries

`getTimeline`

Response

Returns a GetTimelineResponse!

Arguments

Name	Description
`getTimelineParams` - `GetTimelineParams!`

Example

Query

query getTimeline($getTimelineParams: GetTimelineParams!) {
  getTimeline(getTimelineParams: $getTimelineParams) {
    timelineEvents {
      ...BoxHistoryFragment
    }
    total
    page
    limit
  }
}

Variables

{"getTimelineParams": GetTimelineParams}

Response

{
  "data": {
    "getTimeline": {
      "timelineEvents": [BoxHistory],
      "total": 123,
      "page": 123,
      "limit": 987
    }
  }
}

Queries

`getTrackingDetail`

Response

Returns a GetTrackingDetailResponse!

Arguments

Name	Description
`getTrackingDetailParams` - `GetTrackingDetailParams!`

Example

Query

query getTrackingDetail($getTrackingDetailParams: GetTrackingDetailParams!) {
  getTrackingDetail(getTrackingDetailParams: $getTrackingDetailParams) {
    trackingDetail {
      ...TrackingDetailFragment
    }
  }
}

Variables

{"getTrackingDetailParams": GetTrackingDetailParams}

Response

{
  "data": {
    "getTrackingDetail": {
      "trackingDetail": TrackingDetail
    }
  }
}

Queries

`getTrackingDetails`

Response

Returns a GetTrackingDetailsResponse!

Arguments

Name	Description
`getTrackingDetailsParams` - `GetTrackingDetailsParams!`

Example

Query

query getTrackingDetails($getTrackingDetailsParams: GetTrackingDetailsParams!) {
  getTrackingDetails(getTrackingDetailsParams: $getTrackingDetailsParams) {
    trackingDetails {
      ...TrackingDetailFragment
    }
    total
    page
    limit
  }
}

Variables

{"getTrackingDetailsParams": GetTrackingDetailsParams}

Response

{
  "data": {
    "getTrackingDetails": {
      "trackingDetails": [TrackingDetail],
      "total": 123,
      "page": 123,
      "limit": 123
    }
  }
}

Queries

`getTransactions`

Response

Returns a GetTransactionsResponse!

Arguments

Name	Description
`getTransactionsParams` - `GetTransactionsParams!`

Example

Query

query getTransactions($getTransactionsParams: GetTransactionsParams!) {
  getTransactions(getTransactionsParams: $getTransactionsParams) {
    transactions {
      ...BillingManagementTransactionFragment
    }
    total
    page
    limit
  }
}

Variables

{"getTransactionsParams": GetTransactionsParams}

Response

{
  "data": {
    "getTransactions": {
      "transactions": [BillingManagementTransaction],
      "total": 123,
      "page": 987,
      "limit": 987
    }
  }
}

Queries

`getWarehouse`

Response

Returns a GetWarehouseResponse!

Arguments

Name	Description
`getWarehouseParams` - `GetWarehouseParams!`

Example

Query

query getWarehouse($getWarehouseParams: GetWarehouseParams!) {
  getWarehouse(getWarehouseParams: $getWarehouseParams) {
    warehouse {
      ...WarehouseFragment
    }
  }
}

Variables

{"getWarehouseParams": GetWarehouseParams}

Response

{"data": {"getWarehouse": {"warehouse": Warehouse}}}

Queries

`getWarehouseSpot`

Response

Returns a GetWarehouseSpotResponse!

Arguments

Name	Description
`getWarehouseSpotParams` - `GetWarehouseSpotParams!`

Example

Query

query getWarehouseSpot($getWarehouseSpotParams: GetWarehouseSpotParams!) {
  getWarehouseSpot(getWarehouseSpotParams: $getWarehouseSpotParams) {
    warehouseSpot {
      ...WarehouseSpotFragment
    }
  }
}

Variables

{"getWarehouseSpotParams": GetWarehouseSpotParams}

Response

{
  "data": {
    "getWarehouseSpot": {"warehouseSpot": WarehouseSpot}
  }
}

Queries

`getWarehouseSpots`

Response

Returns a GetWarehouseSpotsResponse!

Arguments

Name	Description
`getWarehouseSpotsParams` - `GetWarehouseSpotsParams!`

Example

Query

query getWarehouseSpots($getWarehouseSpotsParams: GetWarehouseSpotsParams!) {
  getWarehouseSpots(getWarehouseSpotsParams: $getWarehouseSpotsParams) {
    warehouseSpots {
      ...WarehouseSpotFragment
    }
    total
    page
    limit
  }
}

Variables

{"getWarehouseSpotsParams": GetWarehouseSpotsParams}

Response

{
  "data": {
    "getWarehouseSpots": {
      "warehouseSpots": [WarehouseSpot],
      "total": 123,
      "page": 123,
      "limit": 987
    }
  }
}

Queries

`getWarehouses`

Response

Returns a GetWarehousesResponse!

Arguments

Name	Description
`getWarehousesParams` - `GetWarehousesParams!`

Example

Query

query getWarehouses($getWarehousesParams: GetWarehousesParams!) {
  getWarehouses(getWarehousesParams: $getWarehousesParams) {
    warehouses {
      ...WarehouseFragment
    }
    total
    page
    limit
  }
}

Variables

{"getWarehousesParams": GetWarehousesParams}

Response

{
  "data": {
    "getWarehouses": {
      "warehouses": [Warehouse],
      "total": 123,
      "page": 987,
      "limit": 123
    }
  }
}

Mutations

`acceptMembershipCancellationRequest`

Response

Returns an AcceptMembershipCancellationRequestResponse!

Arguments

Name	Description
`acceptMembershipCancellationRequestParams` - `AcceptMembershipCancellationRequestParams!`

Example

Query

mutation acceptMembershipCancellationRequest($acceptMembershipCancellationRequestParams: AcceptMembershipCancellationRequestParams!) {
  acceptMembershipCancellationRequest(acceptMembershipCancellationRequestParams: $acceptMembershipCancellationRequestParams) {
    success
  }
}

Variables

{
  "acceptMembershipCancellationRequestParams": AcceptMembershipCancellationRequestParams
}

Response

{"data": {"acceptMembershipCancellationRequest": {"success": false}}}

Mutations

`acknowledgeBoxPacking`

Response

Returns an AcknowledgeBoxPackingResponse!

Arguments

Name	Description
`acknowledgeBoxPackingParams` - `AcknowledgeBoxPackingParams!`

Example

Query

mutation acknowledgeBoxPacking($acknowledgeBoxPackingParams: AcknowledgeBoxPackingParams!) {
  acknowledgeBoxPacking(acknowledgeBoxPackingParams: $acknowledgeBoxPackingParams) {
    box {
      ...BoxFragment
    }
  }
}

Variables

{
  "acknowledgeBoxPackingParams": AcknowledgeBoxPackingParams
}

Response

{"data": {"acknowledgeBoxPacking": {"box": Box}}}

Mutations

`addApplePayPaymentMethod`

Response

Returns an AddApplePayPaymentMethodResponse!

Arguments

Name	Description
`addApplePayPaymentMethodParams` - `AddApplePayPaymentMethodParams!`

Example

Query

mutation addApplePayPaymentMethod($addApplePayPaymentMethodParams: AddApplePayPaymentMethodParams!) {
  addApplePayPaymentMethod(addApplePayPaymentMethodParams: $addApplePayPaymentMethodParams) {
    creditCard {
      ...CustomerCreditCardFragment
    }
  }
}

Variables

{
  "addApplePayPaymentMethodParams": AddApplePayPaymentMethodParams
}

Response

{
  "data": {
    "addApplePayPaymentMethod": {
      "creditCard": CustomerCreditCard
    }
  }
}

Mutations

`addProductPrice`

Response

Returns a ProductPrice!

Arguments

Name	Description
`addProductPriceParams` - `AddProductPriceParams!`

Example

Query

mutation addProductPrice($addProductPriceParams: AddProductPriceParams!) {
  addProductPrice(addProductPriceParams: $addProductPriceParams) {
    id
    productId
    status
    purchaseAmount
    recurrentAmount
    currency
    minStoragePeriodAmount
    minStoragePeriodUnit
    includedStoragePeriodAmount
    includedStoragePeriodUnit
    isDefault
    validFrom
    validUntil
    promotionName
    createdAt
    updatedAt
  }
}

Variables

{"addProductPriceParams": AddProductPriceParams}

Response

{
  "data": {
    "addProductPrice": {
      "id": 123,
      "productId": 123,
      "status": 987,
      "purchaseAmount": 123,
      "recurrentAmount": 987,
      "currency": "USD",
      "minStoragePeriodAmount": 123,
      "minStoragePeriodUnit": 123,
      "includedStoragePeriodAmount": 123,
      "includedStoragePeriodUnit": 123,
      "isDefault": true,
      "validFrom": "2007-12-03",
      "validUntil": "2007-12-03",
      "promotionName": "xyz789",
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03"
    }
  }
}

Mutations

`addShoppingCartLineItems`

Description

Adds line items to an existing shopping cart.

Response

Returns a ShoppingCart!

Arguments

Name	Description
`addShoppingCartLineItemsParams` - `AddShoppingCartLineItemsParams!`

Example

Query

mutation addShoppingCartLineItems($addShoppingCartLineItemsParams: AddShoppingCartLineItemsParams!) {
  addShoppingCartLineItems(addShoppingCartLineItemsParams: $addShoppingCartLineItemsParams) {
    status
    id
    externalId
    anonymousId
    subtotalAmount
    totalAmount
    lineItemList {
      ...ShoppingCartLineItemFragment
    }
    shippingAddress {
      ...ShoppingCartShippingAddressFragment
    }
    discountCoupon {
      ...DiscountCouponResultFragment
    }
    discountAmount
    customer {
      ...ShoppingCartCustomerFragment
    }
    createdAt
    updatedAt
    activeDiscount {
      ...ShoppingCartActiveDiscountFragment
    }
    costs {
      ...ShoppingCartCostFragment
    }
  }
}

Variables

{
  "addShoppingCartLineItemsParams": AddShoppingCartLineItemsParams
}

Response

{
  "data": {
    "addShoppingCartLineItems": {
      "status": "OPEN",
      "id": 987,
      "externalId": "abc123",
      "anonymousId": "xyz789",
      "subtotalAmount": 987,
      "totalAmount": 123,
      "lineItemList": [ShoppingCartLineItem],
      "shippingAddress": ShoppingCartShippingAddress,
      "discountCoupon": DiscountCouponResult,
      "discountAmount": 123,
      "customer": ShoppingCartCustomer,
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03",
      "activeDiscount": ShoppingCartActiveDiscount,
      "costs": ShoppingCartCost
    }
  }
}

Mutations

`adminCancelBox`

Response

Returns a Boolean!

Arguments

Name	Description
`adminCancelBoxParams` - `AdminCancelBoxParams!`

Example

Query

mutation adminCancelBox($adminCancelBoxParams: AdminCancelBoxParams!) {
  adminCancelBox(adminCancelBoxParams: $adminCancelBoxParams)
}

Variables

{"adminCancelBoxParams": AdminCancelBoxParams}

Response

{"data": {"adminCancelBox": true}}

Mutations

`adminCancelPickUp`

Response

Returns a Boolean!

Arguments

Name	Description
`adminCancelPickUpParams` - `AdminCancelPickUpParams!`

Example

Query

mutation adminCancelPickUp($adminCancelPickUpParams: AdminCancelPickUpParams!) {
  adminCancelPickUp(adminCancelPickUpParams: $adminCancelPickUpParams)
}

Variables

{"adminCancelPickUpParams": AdminCancelPickUpParams}

Response

{"data": {"adminCancelPickUp": false}}

Mutations

`adminCheckPickUpAvailability`

Response

Returns an AdminCheckPickUpAvailabilityResponse!

Arguments

Name	Description
`adminCheckPickUpAvailabilityParams` - `AdminCheckPickUpAvailabilityParams!`

Example

Query

mutation adminCheckPickUpAvailability($adminCheckPickUpAvailabilityParams: AdminCheckPickUpAvailabilityParams!) {
  adminCheckPickUpAvailability(adminCheckPickUpAvailabilityParams: $adminCheckPickUpAvailabilityParams) {
    options {
      ...CheckPickUpAvailabilityOptionFragment
    }
  }
}

Variables

{
  "adminCheckPickUpAvailabilityParams": AdminCheckPickUpAvailabilityParams
}

Response

{
  "data": {
    "adminCheckPickUpAvailability": {
      "options": [CheckPickUpAvailabilityOption]
    }
  }
}

Mutations

`adminCreateCustomerAddress`

Response

Returns a CreateCustomerAddressResponse!

Arguments

Name	Description
`createCustomerAddressParams` - `CreateCustomerAddressParams!`

Example

Query

mutation adminCreateCustomerAddress($createCustomerAddressParams: CreateCustomerAddressParams!) {
  adminCreateCustomerAddress(createCustomerAddressParams: $createCustomerAddressParams) {
    address {
      ...CustomerAddressFragment
    }
    correctedAddress {
      ...CorrectedAddressFragment
    }
  }
}

Variables

{
  "createCustomerAddressParams": CreateCustomerAddressParams
}

Response

{
  "data": {
    "adminCreateCustomerAddress": {
      "address": CustomerAddress,
      "correctedAddress": CorrectedAddress
    }
  }
}

Mutations

`adminCreatePickUps`

Response

Returns an AdminCreatePickUpsResponse!

Arguments

Name	Description
`adminCreatePickUpsParams` - `AdminCreatePickUpsParams!`

Example

Query

mutation adminCreatePickUps($adminCreatePickUpsParams: AdminCreatePickUpsParams!) {
  adminCreatePickUps(adminCreatePickUpsParams: $adminCreatePickUpsParams) {
    trackingDetails {
      ...TrackingDetailFragment
    }
  }
}

Variables

{"adminCreatePickUpsParams": AdminCreatePickUpsParams}

Response

{
  "data": {
    "adminCreatePickUps": {
      "trackingDetails": [TrackingDetail]
    }
  }
}

Mutations

`adminDeleteBoxMedia`

Response

Returns a Boolean!

Arguments

Name	Description
`deleteBoxMediaParams` - `DeleteBoxMediaParams!`

Example

Query

mutation adminDeleteBoxMedia($deleteBoxMediaParams: DeleteBoxMediaParams!) {
  adminDeleteBoxMedia(deleteBoxMediaParams: $deleteBoxMediaParams)
}

Variables

{"deleteBoxMediaParams": DeleteBoxMediaParams}

Response

{"data": {"adminDeleteBoxMedia": false}}

Mutations

`adminDeleteCustomerAddress`

Response

Returns a Boolean!

Arguments

Name	Description
`deleteCustomerAddressParams` - `DeleteCustomerAddressParams!`

Example

Query

mutation adminDeleteCustomerAddress($deleteCustomerAddressParams: DeleteCustomerAddressParams!) {
  adminDeleteCustomerAddress(deleteCustomerAddressParams: $deleteCustomerAddressParams)
}

Variables

{
  "deleteCustomerAddressParams": DeleteCustomerAddressParams
}

Response

{"data": {"adminDeleteCustomerAddress": true}}

Mutations

`adminDeleteCustomerPicture`

Response

Returns a Boolean!

Arguments

Name	Description
`deleteCustomerPictureParams` - `DeleteCustomerPictureParams!`

Example

Query

mutation adminDeleteCustomerPicture($deleteCustomerPictureParams: DeleteCustomerPictureParams!) {
  adminDeleteCustomerPicture(deleteCustomerPictureParams: $deleteCustomerPictureParams)
}

Variables

{
  "deleteCustomerPictureParams": DeleteCustomerPictureParams
}

Response

{"data": {"adminDeleteCustomerPicture": false}}

Mutations

`adminUpdateBox`

Response

Returns an AdminUpdateBoxResponse!

Arguments

Name	Description
`adminUpdateBoxParams` - `AdminUpdateBoxParams!`

Example

Query

mutation adminUpdateBox($adminUpdateBoxParams: AdminUpdateBoxParams!) {
  adminUpdateBox(adminUpdateBoxParams: $adminUpdateBoxParams) {
    box {
      ...BoxFragment
    }
  }
}

Variables

{"adminUpdateBoxParams": AdminUpdateBoxParams}

Response

{"data": {"adminUpdateBox": {"box": Box}}}

Mutations

`adminUpdateCustomer`

Response

Returns an UpdateCustomerResponse!

Arguments

Name	Description
`updateCustomerParams` - `UpdateCustomerParams!`

Example

Query

mutation adminUpdateCustomer($updateCustomerParams: UpdateCustomerParams!) {
  adminUpdateCustomer(updateCustomerParams: $updateCustomerParams) {
    customer {
      ...CustomerFragment
    }
  }
}

Variables

{"updateCustomerParams": UpdateCustomerParams}

Response

{"data": {"adminUpdateCustomer": {"customer": Customer}}}

Mutations

`adminUpdateCustomerAddress`

Response

Returns an UpdateCustomerAddressResponse!

Arguments

Name	Description
`updateCustomerAddressParams` - `UpdateCustomerAddressParams!`

Example

Query

mutation adminUpdateCustomerAddress($updateCustomerAddressParams: UpdateCustomerAddressParams!) {
  adminUpdateCustomerAddress(updateCustomerAddressParams: $updateCustomerAddressParams) {
    address {
      ...CustomerAddressFragment
    }
  }
}

Variables

{
  "updateCustomerAddressParams": UpdateCustomerAddressParams
}

Response

{
  "data": {
    "adminUpdateCustomerAddress": {
      "address": CustomerAddress
    }
  }
}

Mutations

`archiveWarehouse`

Response

Returns a Boolean!

Arguments

Name	Description
`archiveWarehouseParams` - `ArchiveWarehouseParams!`

Example

Query

mutation archiveWarehouse($archiveWarehouseParams: ArchiveWarehouseParams!) {
  archiveWarehouse(archiveWarehouseParams: $archiveWarehouseParams)
}

Variables

{"archiveWarehouseParams": ArchiveWarehouseParams}

Response

{"data": {"archiveWarehouse": true}}

Mutations

`assignBoxToCustomer`

Response

Returns an AssignBoxToCustomerResponse!

Arguments

Name	Description
`assignBoxToCustomerParams` - `AssignBoxToCustomerParams!`

Example

Query

mutation assignBoxToCustomer($assignBoxToCustomerParams: AssignBoxToCustomerParams!) {
  assignBoxToCustomer(assignBoxToCustomerParams: $assignBoxToCustomerParams) {
    box {
      ...BoxFragment
    }
  }
}

Variables

{"assignBoxToCustomerParams": AssignBoxToCustomerParams}

Response

{"data": {"assignBoxToCustomer": {"box": Box}}}

Mutations

`assignShoppingCartToCustomerByPhone`

Description

Assigns a shopping cart to a customer by phone.

Response

Returns a ShoppingCart!

Arguments

Name	Description
`assignShoppingCartToCustomerByPhoneParams` - `AssignShoppingCartToCustomerByPhoneParams!`

Example

Query

mutation assignShoppingCartToCustomerByPhone($assignShoppingCartToCustomerByPhoneParams: AssignShoppingCartToCustomerByPhoneParams!) {
  assignShoppingCartToCustomerByPhone(assignShoppingCartToCustomerByPhoneParams: $assignShoppingCartToCustomerByPhoneParams) {
    status
    id
    externalId
    anonymousId
    subtotalAmount
    totalAmount
    lineItemList {
      ...ShoppingCartLineItemFragment
    }
    shippingAddress {
      ...ShoppingCartShippingAddressFragment
    }
    discountCoupon {
      ...DiscountCouponResultFragment
    }
    discountAmount
    customer {
      ...ShoppingCartCustomerFragment
    }
    createdAt
    updatedAt
    activeDiscount {
      ...ShoppingCartActiveDiscountFragment
    }
    costs {
      ...ShoppingCartCostFragment
    }
  }
}

Variables

{
  "assignShoppingCartToCustomerByPhoneParams": AssignShoppingCartToCustomerByPhoneParams
}

Response

{
  "data": {
    "assignShoppingCartToCustomerByPhone": {
      "status": "OPEN",
      "id": 987,
      "externalId": "xyz789",
      "anonymousId": "abc123",
      "subtotalAmount": 987,
      "totalAmount": 987,
      "lineItemList": [ShoppingCartLineItem],
      "shippingAddress": ShoppingCartShippingAddress,
      "discountCoupon": DiscountCouponResult,
      "discountAmount": 987,
      "customer": ShoppingCartCustomer,
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03",
      "activeDiscount": ShoppingCartActiveDiscount,
      "costs": ShoppingCartCost
    }
  }
}

Mutations

`authenticateAdminUser`

Response

Returns a Boolean!

Arguments

Name	Description
`authenticateAdminUserParams` - `AuthenticateAdminUserParams!`

Example

Query

mutation authenticateAdminUser($authenticateAdminUserParams: AuthenticateAdminUserParams!) {
  authenticateAdminUser(authenticateAdminUserParams: $authenticateAdminUserParams)
}

Variables

{
  "authenticateAdminUserParams": AuthenticateAdminUserParams
}

Response

{"data": {"authenticateAdminUser": true}}

Mutations

`authenticateAdminUserValidate`

Response

Returns an AuthenticateAdminUserValidateResponse!

Arguments

Name	Description
`authenticateAdminUserValidateParams` - `AuthenticateAdminUserValidateParams!`

Example

Query

mutation authenticateAdminUserValidate($authenticateAdminUserValidateParams: AuthenticateAdminUserValidateParams!) {
  authenticateAdminUserValidate(authenticateAdminUserValidateParams: $authenticateAdminUserValidateParams) {
    token
    user {
      ...AdminFragment
    }
  }
}

Variables

{
  "authenticateAdminUserValidateParams": AuthenticateAdminUserValidateParams
}

Response

{
  "data": {
    "authenticateAdminUserValidate": {
      "token": "xyz789",
      "user": Admin
    }
  }
}

Mutations

`authenticateCustomer`

Response

Returns a Boolean!

Arguments

Name	Description
`authenticateCustomerParams` - `AuthenticateCustomerParams!`

Example

Query

mutation authenticateCustomer($authenticateCustomerParams: AuthenticateCustomerParams!) {
  authenticateCustomer(authenticateCustomerParams: $authenticateCustomerParams)
}

Variables

{"authenticateCustomerParams": AuthenticateCustomerParams}

Response

{"data": {"authenticateCustomer": false}}

Mutations

`authenticateCustomerValidate`

Response

Returns an AuthenticateCustomerValidateResponse!

Arguments

Name	Description
`authenticateCustomerValidateParams` - `AuthenticateCustomerValidateParams!`

Example

Query

mutation authenticateCustomerValidate($authenticateCustomerValidateParams: AuthenticateCustomerValidateParams!) {
  authenticateCustomerValidate(authenticateCustomerValidateParams: $authenticateCustomerValidateParams) {
    token
    refreshToken
    user {
      ...CustomerFragment
    }
  }
}

Variables

{
  "authenticateCustomerValidateParams": AuthenticateCustomerValidateParams
}

Response

{
  "data": {
    "authenticateCustomerValidate": {
      "token": "abc123",
      "refreshToken": "xyz789",
      "user": Customer
    }
  }
}

Mutations

`buyBoxes`

Use shopping cart flow instead

Response

Returns a BuyBoxesResponse!

Arguments

Name	Description
`buyBoxesParams` - `BuyBoxesParams!`

Example

Query

mutation buyBoxes($buyBoxesParams: BuyBoxesParams!) {
  buyBoxes(buyBoxesParams: $buyBoxesParams) {
    order {
      ...OrderFragment
    }
  }
}

Variables

{"buyBoxesParams": BuyBoxesParams}

Response

{"data": {"buyBoxes": {"order": Order}}}

Mutations

`canSignUp`

Response

Returns a Boolean!

Arguments

Name	Description
`canSignUpParams` - `CanSignUpParams!`

Example

Query

mutation canSignUp($canSignUpParams: CanSignUpParams!) {
  canSignUp(canSignUpParams: $canSignUpParams)
}

Variables

{"canSignUpParams": CanSignUpParams}

Response

{"data": {"canSignUp": true}}

Mutations

`cancelBoxes`

Response

Returns a Boolean!

Arguments

Name	Description
`cancelBoxesParams` - `CancelBoxesParams!`

Example

Query

mutation cancelBoxes($cancelBoxesParams: CancelBoxesParams!) {
  cancelBoxes(cancelBoxesParams: $cancelBoxesParams)
}

Variables

{"cancelBoxesParams": CancelBoxesParams}

Response

{"data": {"cancelBoxes": true}}

Mutations

`cancelDropOff`

Response

Returns a Boolean!

Arguments

Name	Description
`cancelDropOffParams` - `CancelDropOffParams!`

Example

Query

mutation cancelDropOff($cancelDropOffParams: CancelDropOffParams!) {
  cancelDropOff(cancelDropOffParams: $cancelDropOffParams)
}

Variables

{"cancelDropOffParams": CancelDropOffParams}

Response

{"data": {"cancelDropOff": true}}

Mutations

`cancelMembership`

Response

Returns a Boolean!

Arguments

Name	Description
`cancelMembershipParams` - `CancelMembershipParams!`

Example

Query

mutation cancelMembership($cancelMembershipParams: CancelMembershipParams!) {
  cancelMembership(cancelMembershipParams: $cancelMembershipParams)
}

Variables

{"cancelMembershipParams": CancelMembershipParams}

Response

{"data": {"cancelMembership": false}}

Mutations

`cancelOrder`

Response

Returns a CancelOrderResponse!

Arguments

Name	Description
`cancelOrderParams` - `CancelOrderParams!`

Example

Query

mutation cancelOrder($cancelOrderParams: CancelOrderParams!) {
  cancelOrder(cancelOrderParams: $cancelOrderParams) {
    order {
      ...OrderFragment
    }
  }
}

Variables

{"cancelOrderParams": CancelOrderParams}

Response

{"data": {"cancelOrder": {"order": Order}}}

Mutations

`cancelPickUp`

Response

Returns a Boolean!

Arguments

Name	Description
`cancelPickUpParams` - `CancelPickUpParams!`

Example

Query

mutation cancelPickUp($cancelPickUpParams: CancelPickUpParams!) {
  cancelPickUp(cancelPickUpParams: $cancelPickUpParams)
}

Variables

{"cancelPickUpParams": CancelPickUpParams}

Response

{"data": {"cancelPickUp": true}}

Mutations

`checkDiscountCoupon`

Response

Returns a DiscountCouponResult!

Arguments

Name	Description
`checkDiscountCouponParams` - `CheckDiscountCouponParams!`

Example

Query

mutation checkDiscountCoupon($checkDiscountCouponParams: CheckDiscountCouponParams!) {
  checkDiscountCoupon(checkDiscountCouponParams: $checkDiscountCouponParams) {
    id
    code
    type
    amount
    limit
    usage
    startDate
    endDate
    createdAt
    updatedAt
    status
    minimumPurchaseAmount
    maximumPurchaseAmount
    isUnlimited
    minimumBoxesAmount
    applyToRecurrentPayments
    firstPurchaseOnly
    usageLimitPerCustomer
    recurringBillingCyclesLimit
  }
}

Variables

{"checkDiscountCouponParams": CheckDiscountCouponParams}

Response

{
  "data": {
    "checkDiscountCoupon": {
      "id": 987,
      "code": "abc123",
      "type": "abc123",
      "amount": 123.45,
      "limit": 987,
      "usage": 987,
      "startDate": "2007-12-03",
      "endDate": "2007-12-03",
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03",
      "status": "xyz789",
      "minimumPurchaseAmount": 987,
      "maximumPurchaseAmount": 987,
      "isUnlimited": false,
      "minimumBoxesAmount": 123,
      "applyToRecurrentPayments": true,
      "firstPurchaseOnly": false,
      "usageLimitPerCustomer": 987,
      "recurringBillingCyclesLimit": 987
    }
  }
}

Mutations

`checkIfCustomerWouldPlaceAnInitialOrder`

Response

Returns a Boolean!

Arguments

Name	Description
`checkIfCustomerWouldPlaceAnInitialOrderParams` - `CheckIfCustomerWouldPlaceAnInitialOrderParams!`

Example

Query

mutation checkIfCustomerWouldPlaceAnInitialOrder($checkIfCustomerWouldPlaceAnInitialOrderParams: CheckIfCustomerWouldPlaceAnInitialOrderParams!) {
  checkIfCustomerWouldPlaceAnInitialOrder(checkIfCustomerWouldPlaceAnInitialOrderParams: $checkIfCustomerWouldPlaceAnInitialOrderParams)
}

Variables

{
  "checkIfCustomerWouldPlaceAnInitialOrderParams": CheckIfCustomerWouldPlaceAnInitialOrderParams
}

Response

{"data": {"checkIfCustomerWouldPlaceAnInitialOrder": true}}

Mutations

`checkPickUpAvailability`

Response

Returns a CheckPickUpAvailabilityResponse!

Arguments

Name	Description
`checkPickUpAvailabilityParams` - `CheckPickUpAvailabilityParams!`

Example

Query

mutation checkPickUpAvailability($checkPickUpAvailabilityParams: CheckPickUpAvailabilityParams!) {
  checkPickUpAvailability(checkPickUpAvailabilityParams: $checkPickUpAvailabilityParams) {
    options {
      ...CheckPickUpAvailabilityOptionFragment
    }
  }
}

Variables

{
  "checkPickUpAvailabilityParams": CheckPickUpAvailabilityParams
}

Response

{
  "data": {
    "checkPickUpAvailability": {
      "options": [CheckPickUpAvailabilityOption]
    }
  }
}

Mutations

`completeCancellationRequest`

Response

Returns a CompleteCancellationRequestResponse!

Arguments

Name	Description
`completeCancellationRequestParams` - `CompleteCancellationRequestParams!`

Example

Query

mutation completeCancellationRequest($completeCancellationRequestParams: CompleteCancellationRequestParams!) {
  completeCancellationRequest(completeCancellationRequestParams: $completeCancellationRequestParams) {
    cancellationRequest {
      ...CancellationRequestFragment
    }
  }
}

Variables

{
  "completeCancellationRequestParams": CompleteCancellationRequestParams
}

Response

{
  "data": {
    "completeCancellationRequest": {
      "cancellationRequest": CancellationRequest
    }
  }
}

Mutations

`completeOrder`

Response

Returns a CompleteOrderResponse!

Arguments

Name	Description
`completeOrderParams` - `CompleteOrderParams!`

Example

Query

mutation completeOrder($completeOrderParams: CompleteOrderParams!) {
  completeOrder(completeOrderParams: $completeOrderParams) {
    order {
      ...OrderFragment
    }
  }
}

Variables

{"completeOrderParams": CompleteOrderParams}

Response

{"data": {"completeOrder": {"order": Order}}}

Mutations

`confirmSignUp`

Response

Returns a ConfirmSignUpResponse!

Arguments

Name	Description
`confirmSignUpParams` - `ConfirmSignUpParams!`

Example

Query

mutation confirmSignUp($confirmSignUpParams: ConfirmSignUpParams!) {
  confirmSignUp(confirmSignUpParams: $confirmSignUpParams) {
    token
    refreshToken
    user {
      ...CustomerFragment
    }
  }
}

Variables

{"confirmSignUpParams": ConfirmSignUpParams}

Response

{
  "data": {
    "confirmSignUp": {
      "token": "abc123",
      "refreshToken": "abc123",
      "user": Customer
    }
  }
}

Mutations

`createAdminUser`

Response

Returns a CreateAdminUserResponse!

Arguments

Name	Description
`createAdminUserParams` - `CreateAdminUserParams!`

Example

Query

mutation createAdminUser($createAdminUserParams: CreateAdminUserParams!) {
  createAdminUser(createAdminUserParams: $createAdminUserParams) {
    admin {
      ...AdminFragment
    }
  }
}

Variables

{"createAdminUserParams": CreateAdminUserParams}

Response

{"data": {"createAdminUser": {"admin": Admin}}}

Mutations

`createApiKey`

Response

Returns a CreateApiKeyResponse!

Arguments

Name	Description
`createApiKeyParams` - `CreateApiKeyParams!`

Example

Query

mutation createApiKey($createApiKeyParams: CreateApiKeyParams!) {
  createApiKey(createApiKeyParams: $createApiKeyParams) {
    apiKey {
      ...ApiKeyFragment
    }
  }
}

Variables

{"createApiKeyParams": CreateApiKeyParams}

Response

{"data": {"createApiKey": {"apiKey": ApiKey}}}

Mutations

`createBoxType`

Response

Returns a CreateBoxTypeResponse!

Arguments

Name	Description
`createBoxTypeParams` - `CreateBoxTypeParams!`

Example

Query

mutation createBoxType($createBoxTypeParams: CreateBoxTypeParams!) {
  createBoxType(createBoxTypeParams: $createBoxTypeParams) {
    boxType {
      ...BoxTypeFragment
    }
  }
}

Variables

{"createBoxTypeParams": CreateBoxTypeParams}

Response

{"data": {"createBoxType": {"boxType": BoxType}}}

Mutations

`createConfigurableParameter`

Response

Returns a CreateConfigurableParameterResponse!

Arguments

Name	Description
`createConfigurableParameterParams` - `CreateConfigurableParameterParams!`

Example

Query

mutation createConfigurableParameter($createConfigurableParameterParams: CreateConfigurableParameterParams!) {
  createConfigurableParameter(createConfigurableParameterParams: $createConfigurableParameterParams) {
    configurableParameter {
      ...ConfigurableParameterFragment
    }
  }
}

Variables

{
  "createConfigurableParameterParams": CreateConfigurableParameterParams
}

Response

{
  "data": {
    "createConfigurableParameter": {
      "configurableParameter": ConfigurableParameter
    }
  }
}

Mutations

`createCustomer`

Response

Returns a CreateCustomerResponse!

Arguments

Name	Description
`createCustomerParams` - `CreateCustomerParams!`

Example

Query

mutation createCustomer($createCustomerParams: CreateCustomerParams!) {
  createCustomer(createCustomerParams: $createCustomerParams) {
    customer {
      ...CustomerFragment
    }
  }
}

Variables

{"createCustomerParams": CreateCustomerParams}

Response

{"data": {"createCustomer": {"customer": Customer}}}

Mutations

`createCustomerAddress`

Response

Returns a CreateCustomerAddressResponse!

Arguments

Name	Description
`createCustomerAddressParams` - `CreateCustomerAddressParams!`

Example

Query

mutation createCustomerAddress($createCustomerAddressParams: CreateCustomerAddressParams!) {
  createCustomerAddress(createCustomerAddressParams: $createCustomerAddressParams) {
    address {
      ...CustomerAddressFragment
    }
    correctedAddress {
      ...CorrectedAddressFragment
    }
  }
}

Variables

{
  "createCustomerAddressParams": CreateCustomerAddressParams
}

Response

{
  "data": {
    "createCustomerAddress": {
      "address": CustomerAddress,
      "correctedAddress": CorrectedAddress
    }
  }
}

Mutations

`createCustomerCreditCard`

Response

Returns a CreateCustomerCreditCardResponse!

Arguments

Name	Description
`createCustomerCreditCardParams` - `CreateCustomerCreditCardParams!`

Example

Query

mutation createCustomerCreditCard($createCustomerCreditCardParams: CreateCustomerCreditCardParams!) {
  createCustomerCreditCard(createCustomerCreditCardParams: $createCustomerCreditCardParams) {
    creditCard {
      ...CustomerCreditCardFragment
    }
  }
}

Variables

{
  "createCustomerCreditCardParams": CreateCustomerCreditCardParams
}

Response

{
  "data": {
    "createCustomerCreditCard": {
      "creditCard": CustomerCreditCard
    }
  }
}

Mutations

`createCustomerGroup`

Response

Returns a CreateCustomerGroupResponse!

Arguments

Name	Description
`createCustomerGroupParams` - `CreateCustomerGroupParams!`

Example

Query

mutation createCustomerGroup($createCustomerGroupParams: CreateCustomerGroupParams!) {
  createCustomerGroup(createCustomerGroupParams: $createCustomerGroupParams) {
    customerGroup {
      ...CustomerGroupFragment
    }
  }
}

Variables

{"createCustomerGroupParams": CreateCustomerGroupParams}

Response

{
  "data": {
    "createCustomerGroup": {
      "customerGroup": CustomerGroup
    }
  }
}

Mutations

`createCustomerPaymentMethod`

Response

Returns a CreateCustomerPaymentMethodResponse!

Arguments

Name	Description
`createCustomerPaymentMethodParams` - `CreateCustomerPaymentMethodParams!`

Example

Query

mutation createCustomerPaymentMethod($createCustomerPaymentMethodParams: CreateCustomerPaymentMethodParams!) {
  createCustomerPaymentMethod(createCustomerPaymentMethodParams: $createCustomerPaymentMethodParams) {
    paymentMethod {
      ...CustomerCreditCardFragment
    }
  }
}

Variables

{
  "createCustomerPaymentMethodParams": CreateCustomerPaymentMethodParams
}

Response

{
  "data": {
    "createCustomerPaymentMethod": {
      "paymentMethod": CustomerCreditCard
    }
  }
}

Mutations

`createDiscountCoupon`

Response

Returns a DiscountCouponResult!

Arguments

Name	Description
`createDiscountCouponParams` - `CreateDiscountCouponParams!`

Example

Query

mutation createDiscountCoupon($createDiscountCouponParams: CreateDiscountCouponParams!) {
  createDiscountCoupon(createDiscountCouponParams: $createDiscountCouponParams) {
    id
    code
    type
    amount
    limit
    usage
    startDate
    endDate
    createdAt
    updatedAt
    status
    minimumPurchaseAmount
    maximumPurchaseAmount
    isUnlimited
    minimumBoxesAmount
    applyToRecurrentPayments
    firstPurchaseOnly
    usageLimitPerCustomer
    recurringBillingCyclesLimit
  }
}

Variables

{"createDiscountCouponParams": CreateDiscountCouponParams}

Response

{
  "data": {
    "createDiscountCoupon": {
      "id": 987,
      "code": "abc123",
      "type": "abc123",
      "amount": 123.45,
      "limit": 987,
      "usage": 123,
      "startDate": "2007-12-03",
      "endDate": "2007-12-03",
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03",
      "status": "abc123",
      "minimumPurchaseAmount": 987,
      "maximumPurchaseAmount": 987,
      "isUnlimited": false,
      "minimumBoxesAmount": 123,
      "applyToRecurrentPayments": true,
      "firstPurchaseOnly": true,
      "usageLimitPerCustomer": 987,
      "recurringBillingCyclesLimit": 123
    }
  }
}

Mutations

`createDropOff`

Response

Returns a CreateDropOffResponse!

Arguments

Name	Description
`createDropOffParams` - `CreateDropOffParams!`

Example

Query

mutation createDropOff($createDropOffParams: CreateDropOffParams!) {
  createDropOff(createDropOffParams: $createDropOffParams) {
    trackingDetail {
      ...TrackingDetailFragment
    }
  }
}

Variables

{"createDropOffParams": CreateDropOffParams}

Response

{
  "data": {
    "createDropOff": {"trackingDetail": TrackingDetail}
  }
}

Mutations

`createDropOffs`

Response

Returns a CreateDropOffsResponse!

Arguments

Name	Description
`createDropOffsParams` - `CreateDropOffsParams!`

Example

Query

mutation createDropOffs($createDropOffsParams: CreateDropOffsParams!) {
  createDropOffs(createDropOffsParams: $createDropOffsParams) {
    trackingDetails {
      ...TrackingDetailFragment
    }
  }
}

Variables

{"createDropOffsParams": CreateDropOffsParams}

Response

{
  "data": {
    "createDropOffs": {
      "trackingDetails": [TrackingDetail]
    }
  }
}

Mutations

`createNote`

Response

Returns a CreateNoteResponse!

Arguments

Name	Description
`createNoteParams` - `CreateNoteParams!`

Example

Query

mutation createNote($createNoteParams: CreateNoteParams!) {
  createNote(createNoteParams: $createNoteParams) {
    note {
      ...NoteFragment
    }
  }
}

Variables

{"createNoteParams": CreateNoteParams}

Response

{"data": {"createNote": {"note": Note}}}

Mutations

`createOrderFromCart`

Response

Returns a CreateOrderFromCartResponse!

Arguments

Name	Description
`createOrderFromCartParams` - `CreateOrderFromCartParams!`

Example

Query

mutation createOrderFromCart($createOrderFromCartParams: CreateOrderFromCartParams!) {
  createOrderFromCart(createOrderFromCartParams: $createOrderFromCartParams) {
    order {
      ...OrderFragment
    }
  }
}

Variables

{"createOrderFromCartParams": CreateOrderFromCartParams}

Response

{"data": {"createOrderFromCart": {"order": Order}}}

Mutations

`createPickUp`

Response

Returns a CreatePickUpResponse!

Arguments

Name	Description
`createPickUpParams` - `CreatePickUpParams!`

Example

Query

mutation createPickUp($createPickUpParams: CreatePickUpParams!) {
  createPickUp(createPickUpParams: $createPickUpParams) {
    trackingDetail {
      ...TrackingDetailFragment
    }
  }
}

Variables

{"createPickUpParams": CreatePickUpParams}

Response

{
  "data": {
    "createPickUp": {"trackingDetail": TrackingDetail}
  }
}

Mutations

`createPickUps`

Response

Returns a CreatePickUpsResponse!

Arguments

Name	Description
`createPickUpsParams` - `CreatePickUpsParams!`

Example

Query

mutation createPickUps($createPickUpsParams: CreatePickUpsParams!) {
  createPickUps(createPickUpsParams: $createPickUpsParams) {
    trackingDetails {
      ...TrackingDetailFragment
    }
  }
}

Variables

{"createPickUpsParams": CreatePickUpsParams}

Response

{
  "data": {
    "createPickUps": {"trackingDetails": [TrackingDetail]}
  }
}

Mutations

`createProduct`

Response

Returns a CreateProductResponse!

Arguments

Name	Description
`createProductParams` - `CreateProductParams!`

Example

Query

mutation createProduct($createProductParams: CreateProductParams!) {
  createProduct(createProductParams: $createProductParams) {
    product {
      ...ProductFragment
    }
  }
}

Variables

{"createProductParams": CreateProductParams}

Response

{"data": {"createProduct": {"product": Product}}}

Mutations

`createShoppingCart`

Description

Creates a new shopping cart for a customer or an anonymous user.

Response

Returns a ShoppingCart!

Arguments

Name	Description
`createShoppingCartParams` - `CreateShoppingCartParams!`

Example

Query

mutation createShoppingCart($createShoppingCartParams: CreateShoppingCartParams!) {
  createShoppingCart(createShoppingCartParams: $createShoppingCartParams) {
    status
    id
    externalId
    anonymousId
    subtotalAmount
    totalAmount
    lineItemList {
      ...ShoppingCartLineItemFragment
    }
    shippingAddress {
      ...ShoppingCartShippingAddressFragment
    }
    discountCoupon {
      ...DiscountCouponResultFragment
    }
    discountAmount
    customer {
      ...ShoppingCartCustomerFragment
    }
    createdAt
    updatedAt
    activeDiscount {
      ...ShoppingCartActiveDiscountFragment
    }
    costs {
      ...ShoppingCartCostFragment
    }
  }
}

Variables

{"createShoppingCartParams": CreateShoppingCartParams}

Response

{
  "data": {
    "createShoppingCart": {
      "status": "OPEN",
      "id": 987,
      "externalId": "abc123",
      "anonymousId": "abc123",
      "subtotalAmount": 987,
      "totalAmount": 123,
      "lineItemList": [ShoppingCartLineItem],
      "shippingAddress": ShoppingCartShippingAddress,
      "discountCoupon": DiscountCouponResult,
      "discountAmount": 123,
      "customer": ShoppingCartCustomer,
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03",
      "activeDiscount": ShoppingCartActiveDiscount,
      "costs": ShoppingCartCost
    }
  }
}

Mutations

`createWarehouse`

Response

Returns a CreateWarehouseResponse!

Arguments

Name	Description
`createWarehouseParams` - `CreateWarehouseParams!`

Example

Query

mutation createWarehouse($createWarehouseParams: CreateWarehouseParams!) {
  createWarehouse(createWarehouseParams: $createWarehouseParams) {
    warehouse {
      ...WarehouseFragment
    }
  }
}

Variables

{"createWarehouseParams": CreateWarehouseParams}

Response

{"data": {"createWarehouse": {"warehouse": Warehouse}}}

Mutations

`createWarehouseSpot`

Response

Returns a CreateWarehouseSpotResponse!

Arguments

Name	Description
`createWarehouseSpotParams` - `CreateWarehouseSpotParams!`

Example

Query

mutation createWarehouseSpot($createWarehouseSpotParams: CreateWarehouseSpotParams!) {
  createWarehouseSpot(createWarehouseSpotParams: $createWarehouseSpotParams) {
    warehouseSpot {
      ...WarehouseSpotFragment
    }
  }
}

Variables

{"createWarehouseSpotParams": CreateWarehouseSpotParams}

Response

{
  "data": {
    "createWarehouseSpot": {
      "warehouseSpot": WarehouseSpot
    }
  }
}

Mutations

`createWarehouseSpots`

Response

Returns a CreateWarehouseSpotsResponse!

Arguments

Name	Description
`createWarehouseSpotsParams` - `CreateWarehouseSpotsParams!`

Example

Query

mutation createWarehouseSpots($createWarehouseSpotsParams: CreateWarehouseSpotsParams!) {
  createWarehouseSpots(createWarehouseSpotsParams: $createWarehouseSpotsParams) {
    first
    last
    count
    codes
  }
}

Variables

{"createWarehouseSpotsParams": CreateWarehouseSpotsParams}

Response

{
  "data": {
    "createWarehouseSpots": {
      "first": "xyz789",
      "last": "abc123",
      "count": 123,
      "codes": ["abc123"]
    }
  }
}

Mutations

`deleteAdminUser`

Response

Returns a Boolean!

Arguments

Name	Description
`deleteAdminUserParams` - `DeleteAdminUserParams!`

Example

Query

mutation deleteAdminUser($deleteAdminUserParams: DeleteAdminUserParams!) {
  deleteAdminUser(deleteAdminUserParams: $deleteAdminUserParams)
}

Variables

{"deleteAdminUserParams": DeleteAdminUserParams}

Response

{"data": {"deleteAdminUser": true}}

Mutations

`deleteApiKey`

Response

Returns a Boolean!

Arguments

Name	Description
`deleteApiKeyParams` - `DeleteApiKeyParams!`

Example

Query

mutation deleteApiKey($deleteApiKeyParams: DeleteApiKeyParams!) {
  deleteApiKey(deleteApiKeyParams: $deleteApiKeyParams)
}

Variables

{"deleteApiKeyParams": DeleteApiKeyParams}

Response

{"data": {"deleteApiKey": false}}

Mutations

`deleteBoxMedia`

Response

Returns a Boolean!

Arguments

Name	Description
`deleteBoxMediaParams` - `DeleteBoxMediaParams!`

Example

Query

mutation deleteBoxMedia($deleteBoxMediaParams: DeleteBoxMediaParams!) {
  deleteBoxMedia(deleteBoxMediaParams: $deleteBoxMediaParams)
}

Variables

{"deleteBoxMediaParams": DeleteBoxMediaParams}

Response

{"data": {"deleteBoxMedia": true}}

Mutations

`deleteBoxType`

Response

Returns a Boolean!

Arguments

Name	Description
`deleteBoxTypeParams` - `DeleteBoxTypeParams!`

Example

Query

mutation deleteBoxType($deleteBoxTypeParams: DeleteBoxTypeParams!) {
  deleteBoxType(deleteBoxTypeParams: $deleteBoxTypeParams)
}

Variables

{"deleteBoxTypeParams": DeleteBoxTypeParams}

Response

{"data": {"deleteBoxType": false}}

Mutations

`deleteConfigurableParameter`

Response

Returns a Boolean!

Arguments

Name	Description
`deleteConfigurableParameterParams` - `DeleteConfigurableParameterParams!`

Example

Query

mutation deleteConfigurableParameter($deleteConfigurableParameterParams: DeleteConfigurableParameterParams!) {
  deleteConfigurableParameter(deleteConfigurableParameterParams: $deleteConfigurableParameterParams)
}

Variables

{
  "deleteConfigurableParameterParams": DeleteConfigurableParameterParams
}

Response

{"data": {"deleteConfigurableParameter": true}}

Mutations

`deleteCustomer`

Response

Returns a Boolean!

Example

Query

mutation deleteCustomer {
  deleteCustomer
}

Response

{"data": {"deleteCustomer": false}}

Mutations

`deleteCustomerAddress`

Response

Returns a Boolean!

Arguments

Name	Description
`deleteCustomerAddressParams` - `DeleteCustomerAddressParams!`

Example

Query

mutation deleteCustomerAddress($deleteCustomerAddressParams: DeleteCustomerAddressParams!) {
  deleteCustomerAddress(deleteCustomerAddressParams: $deleteCustomerAddressParams)
}

Variables

{
  "deleteCustomerAddressParams": DeleteCustomerAddressParams
}

Response

{"data": {"deleteCustomerAddress": false}}

Mutations

`deleteCustomerCreditCard`

Response

Returns a Boolean!

Arguments

Name	Description
`deleteCustomerCreditCardParams` - `DeleteCustomerCreditCardParams!`

Example

Query

mutation deleteCustomerCreditCard($deleteCustomerCreditCardParams: DeleteCustomerCreditCardParams!) {
  deleteCustomerCreditCard(deleteCustomerCreditCardParams: $deleteCustomerCreditCardParams)
}

Variables

{
  "deleteCustomerCreditCardParams": DeleteCustomerCreditCardParams
}

Response

{"data": {"deleteCustomerCreditCard": true}}

Mutations

`deleteCustomerPicture`

Response

Returns a Boolean!

Arguments

Name	Description
`deleteCustomerPictureParams` - `DeleteCustomerPictureParams!`

Example

Query

mutation deleteCustomerPicture($deleteCustomerPictureParams: DeleteCustomerPictureParams!) {
  deleteCustomerPicture(deleteCustomerPictureParams: $deleteCustomerPictureParams)
}

Variables

{
  "deleteCustomerPictureParams": DeleteCustomerPictureParams
}

Response

{"data": {"deleteCustomerPicture": true}}

Mutations

`deleteNote`

Response

Returns a Boolean!

Arguments

Name	Description
`deleteNoteParams` - `DeleteNoteParams!`

Example

Query

mutation deleteNote($deleteNoteParams: DeleteNoteParams!) {
  deleteNote(deleteNoteParams: $deleteNoteParams)
}

Variables

{"deleteNoteParams": DeleteNoteParams}

Response

{"data": {"deleteNote": false}}

Mutations

`deleteProduct`

Response

Returns a Boolean!

Arguments

Name	Description
`deleteProductParams` - `DeleteProductParams!`

Example

Query

mutation deleteProduct($deleteProductParams: DeleteProductParams!) {
  deleteProduct(deleteProductParams: $deleteProductParams)
}

Variables

{"deleteProductParams": DeleteProductParams}

Response

{"data": {"deleteProduct": false}}

Mutations

`deleteProductImages`

Response

Returns a Boolean!

Arguments

Name	Description
`deleteProductImagesParams` - `DeleteProductImagesParams!`

Example

Query

mutation deleteProductImages($deleteProductImagesParams: DeleteProductImagesParams!) {
  deleteProductImages(deleteProductImagesParams: $deleteProductImagesParams)
}

Variables

{"deleteProductImagesParams": DeleteProductImagesParams}

Response

{"data": {"deleteProductImages": true}}

Mutations

`deleteWarehouseSpot`

Response

Returns a Boolean!

Arguments

Name	Description
`deleteWarehouseSpotParams` - `DeleteWarehouseSpotParams!`

Example

Query

mutation deleteWarehouseSpot($deleteWarehouseSpotParams: DeleteWarehouseSpotParams!) {
  deleteWarehouseSpot(deleteWarehouseSpotParams: $deleteWarehouseSpotParams)
}

Variables

{"deleteWarehouseSpotParams": DeleteWarehouseSpotParams}

Response

{"data": {"deleteWarehouseSpot": true}}

Mutations

`excludeCustomerFromCustomerGroup`

Response

Returns a Boolean!

Arguments

Name	Description
`excludeCustomerFromCustomerGroupParams` - `ExcludeCustomerFromCustomerGroupParams!`

Example

Query

mutation excludeCustomerFromCustomerGroup($excludeCustomerFromCustomerGroupParams: ExcludeCustomerFromCustomerGroupParams!) {
  excludeCustomerFromCustomerGroup(excludeCustomerFromCustomerGroupParams: $excludeCustomerFromCustomerGroupParams)
}

Variables

{
  "excludeCustomerFromCustomerGroupParams": ExcludeCustomerFromCustomerGroupParams
}

Response

{"data": {"excludeCustomerFromCustomerGroup": false}}

Mutations

`generateOrderReturnLabels`

Response

Returns a Boolean!

Arguments

Name	Description
`generateOrderReturnLabelsParams` - `GenerateOrderReturnLabelsParams!`

Example

Query

mutation generateOrderReturnLabels($generateOrderReturnLabelsParams: GenerateOrderReturnLabelsParams!) {
  generateOrderReturnLabels(generateOrderReturnLabelsParams: $generateOrderReturnLabelsParams)
}

Variables

{
  "generateOrderReturnLabelsParams": GenerateOrderReturnLabelsParams
}

Response

{"data": {"generateOrderReturnLabels": false}}

Mutations

`generateOrderShippingLabels`

Response

Returns a Boolean!

Arguments

Name	Description
`generateOrderShippingLabelsParams` - `GenerateOrderShippingLabelsParams!`

Example

Query

mutation generateOrderShippingLabels($generateOrderShippingLabelsParams: GenerateOrderShippingLabelsParams!) {
  generateOrderShippingLabels(generateOrderShippingLabelsParams: $generateOrderShippingLabelsParams)
}

Variables

{
  "generateOrderShippingLabelsParams": GenerateOrderShippingLabelsParams
}

Response

{"data": {"generateOrderShippingLabels": false}}

Mutations

`generatePayPalClientToken`

Description

Generate PayPal client token

Response

Returns a GeneratePayPalClientTokenResponse!

Example

Query

mutation generatePayPalClientToken {
  generatePayPalClientToken {
    clientToken
  }
}

Response

{
  "data": {
    "generatePayPalClientToken": {
      "clientToken": "abc123"
    }
  }
}

Mutations

`generateReturnLabels`

Response

Returns a Boolean!

Arguments

Name	Description
`generateReturnLabelsParams` - `GenerateReturnLabelsParams!`

Example

Query

mutation generateReturnLabels($generateReturnLabelsParams: GenerateReturnLabelsParams!) {
  generateReturnLabels(generateReturnLabelsParams: $generateReturnLabelsParams)
}

Variables

{"generateReturnLabelsParams": GenerateReturnLabelsParams}

Response

{"data": {"generateReturnLabels": false}}

Mutations

`generateSerialNumbers`

Response

Returns a Boolean!

Arguments

Name	Description
`generateSerialNumbersParams` - `GenerateSerialNumbersParams!`

Example

Query

mutation generateSerialNumbers($generateSerialNumbersParams: GenerateSerialNumbersParams!) {
  generateSerialNumbers(generateSerialNumbersParams: $generateSerialNumbersParams)
}

Variables

{
  "generateSerialNumbersParams": GenerateSerialNumbersParams
}

Response

{"data": {"generateSerialNumbers": true}}

Mutations

`includeCustomerToCustomerGroup`

Response

Returns a Boolean!

Arguments

Name	Description
`includeCustomerToCustomerGroupParams` - `IncludeCustomerToCustomerGroupParams!`

Example

Query

mutation includeCustomerToCustomerGroup($includeCustomerToCustomerGroupParams: IncludeCustomerToCustomerGroupParams!) {
  includeCustomerToCustomerGroup(includeCustomerToCustomerGroupParams: $includeCustomerToCustomerGroupParams)
}

Variables

{
  "includeCustomerToCustomerGroupParams": IncludeCustomerToCustomerGroupParams
}

Response

{"data": {"includeCustomerToCustomerGroup": true}}

Mutations

`inductBoxes`

Use 'generateSerialNumbers' and 'generateReturnLabels' instead

Response

Returns a Boolean!

Arguments

Name	Description
`inductBoxesParams` - `InductBoxesParams!`

Example

Query

mutation inductBoxes($inductBoxesParams: InductBoxesParams!) {
  inductBoxes(inductBoxesParams: $inductBoxesParams)
}

Variables

{"inductBoxesParams": InductBoxesParams}

Response

{"data": {"inductBoxes": true}}

Mutations

`lockBox`

Response

Returns a LockBoxResponse!

Arguments

Name	Description
`lockBoxParams` - `LockBoxParams!`

Example

Query

mutation lockBox($lockBoxParams: LockBoxParams!) {
  lockBox(lockBoxParams: $lockBoxParams) {
    box {
      ...BoxFragment
    }
  }
}

Variables

{"lockBoxParams": LockBoxParams}

Response

{"data": {"lockBox": {"box": Box}}}

Mutations

`packBox`

Response

Returns a PackBoxResponse!

Arguments

Name	Description
`packBoxParams` - `PackBoxParams!`

Example

Query

mutation packBox($packBoxParams: PackBoxParams!) {
  packBox(packBoxParams: $packBoxParams) {
    box {
      ...BoxFragment
    }
  }
}

Variables

{"packBoxParams": PackBoxParams}

Response

{"data": {"packBox": {"box": Box}}}

Mutations

`processAddOnOrder`

Use processPurchaseOrder instead

Response

Returns a ProcessOrderResponse!

Arguments

Name	Description
`processOrderParams` - `ProcessOrderParams!`

Example

Query

mutation processAddOnOrder($processOrderParams: ProcessOrderParams!) {
  processAddOnOrder(processOrderParams: $processOrderParams) {
    order {
      ...OrderFragment
    }
  }
}

Variables

{"processOrderParams": ProcessOrderParams}

Response

{"data": {"processAddOnOrder": {"order": Order}}}

Mutations

`processInitialOrder`

Use processPurchaseOrder instead

Response

Returns a ProcessOrderResponse!

Arguments

Name	Description
`processOrderParams` - `ProcessOrderParams!`

Example

Query

mutation processInitialOrder($processOrderParams: ProcessOrderParams!) {
  processInitialOrder(processOrderParams: $processOrderParams) {
    order {
      ...OrderFragment
    }
  }
}

Variables

{"processOrderParams": ProcessOrderParams}

Response

{"data": {"processInitialOrder": {"order": Order}}}

Mutations

`processPurchaseOrder`

Response

Returns a ProcessPurchaseOrderResponse!

Arguments

Name	Description
`processPurchaseOrderParams` - `ProcessPurchaseOrderParams!`

Example

Query

mutation processPurchaseOrder($processPurchaseOrderParams: ProcessPurchaseOrderParams!) {
  processPurchaseOrder(processPurchaseOrderParams: $processPurchaseOrderParams) {
    order {
      ...OrderFragment
    }
  }
}

Variables

{"processPurchaseOrderParams": ProcessPurchaseOrderParams}

Response

{"data": {"processPurchaseOrder": {"order": Order}}}

Mutations

`processRTUOrder`

Response

Returns a Boolean!

Arguments

Name	Description
`processRTUOrderParams` - `ProcessRTUOrderParams!`

Example

Query

mutation processRTUOrder($processRTUOrderParams: ProcessRTUOrderParams!) {
  processRTUOrder(processRTUOrderParams: $processRTUOrderParams)
}

Variables

{"processRTUOrderParams": ProcessRTUOrderParams}

Response

{"data": {"processRTUOrder": true}}

Mutations

`receiveBox`

Response

Returns a ReceiveBoxResponse!

Arguments

Name	Description
`receiveBoxParams` - `ReceiveBoxParams!`

Example

Query

mutation receiveBox($receiveBoxParams: ReceiveBoxParams!) {
  receiveBox(receiveBoxParams: $receiveBoxParams) {
    box {
      ...BoxFragment
    }
  }
}

Variables

{"receiveBoxParams": ReceiveBoxParams}

Response

{"data": {"receiveBox": {"box": Box}}}

Mutations

`reconcileOpenOrder`

Response

Returns a ReconcileOpenOrderResponse!

Arguments

Name	Description
`reconcileOpenOrderParams` - `ReconcileOpenOrderParams!`

Example

Query

mutation reconcileOpenOrder($reconcileOpenOrderParams: ReconcileOpenOrderParams!) {
  reconcileOpenOrder(reconcileOpenOrderParams: $reconcileOpenOrderParams) {
    orderId
    affectedTrackingNumbers
    updated
    previousStatus
    newStatus
  }
}

Variables

{"reconcileOpenOrderParams": ReconcileOpenOrderParams}

Response

{
  "data": {
    "reconcileOpenOrder": {
      "orderId": 987,
      "affectedTrackingNumbers": ["abc123"],
      "updated": false,
      "previousStatus": 987,
      "newStatus": 123
    }
  }
}

Mutations

`reconcileOpenTrackingDetail`

Response

Returns a ReconcileOpenTrackingDetailResponse!

Arguments

Name	Description
`reconcileOpenTrackingDetailParams` - `ReconcileOpenTrackingDetailParams!`

Example

Query

mutation reconcileOpenTrackingDetail($reconcileOpenTrackingDetailParams: ReconcileOpenTrackingDetailParams!) {
  reconcileOpenTrackingDetail(reconcileOpenTrackingDetailParams: $reconcileOpenTrackingDetailParams) {
    trackingDetailId
    affectedTrackingNumbers
    updated
    previousStatus
    newStatus
  }
}

Variables

{
  "reconcileOpenTrackingDetailParams": ReconcileOpenTrackingDetailParams
}

Response

{
  "data": {
    "reconcileOpenTrackingDetail": {
      "trackingDetailId": 987,
      "affectedTrackingNumbers": ["abc123"],
      "updated": true,
      "previousStatus": 987,
      "newStatus": 987
    }
  }
}

Mutations

`recordFirstAppLogin`

Response

Returns a Boolean!

Example

Query

mutation recordFirstAppLogin {
  recordFirstAppLogin
}

Response

{"data": {"recordFirstAppLogin": true}}

Mutations

`refreshCustomerToken`

Response

Returns a RefreshCustomerTokenResponse!

Arguments

Name	Description
`refreshCustomerTokenParams` - `RefreshCustomerTokenParams!`

Example

Query

mutation refreshCustomerToken($refreshCustomerTokenParams: RefreshCustomerTokenParams!) {
  refreshCustomerToken(refreshCustomerTokenParams: $refreshCustomerTokenParams) {
    token
    refreshToken
    user {
      ...CustomerFragment
    }
  }
}

Variables

{"refreshCustomerTokenParams": RefreshCustomerTokenParams}

Response

{
  "data": {
    "refreshCustomerToken": {
      "token": "abc123",
      "refreshToken": "xyz789",
      "user": Customer
    }
  }
}

Mutations

`rejectCancellationRequest`

Response

Returns a RejectCancellationRequestResponse!

Arguments

Name	Description
`rejectCancellationRequestParams` - `RejectCancellationRequestParams!`

Example

Query

mutation rejectCancellationRequest($rejectCancellationRequestParams: RejectCancellationRequestParams!) {
  rejectCancellationRequest(rejectCancellationRequestParams: $rejectCancellationRequestParams) {
    cancellationRequest {
      ...CancellationRequestFragment
    }
  }
}

Variables

{
  "rejectCancellationRequestParams": RejectCancellationRequestParams
}

Response

{
  "data": {
    "rejectCancellationRequest": {
      "cancellationRequest": CancellationRequest
    }
  }
}

Mutations

`rejectMembershipCancellationRequest`

Response

Returns a RejectMembershipCancellationRequestResponse!

Arguments

Name	Description
`rejectMembershipCancellationRequestParams` - `RejectMembershipCancellationRequestParams!`

Example

Query

mutation rejectMembershipCancellationRequest($rejectMembershipCancellationRequestParams: RejectMembershipCancellationRequestParams!) {
  rejectMembershipCancellationRequest(rejectMembershipCancellationRequestParams: $rejectMembershipCancellationRequestParams) {
    success
  }
}

Variables

{
  "rejectMembershipCancellationRequestParams": RejectMembershipCancellationRequestParams
}

Response

{"data": {"rejectMembershipCancellationRequest": {"success": false}}}

Mutations

`removeProductPrice`

Response

Returns a Boolean!

Arguments

Name	Description
`removeProductPriceParams` - `RemoveProductPriceParams!`

Example

Query

mutation removeProductPrice($removeProductPriceParams: RemoveProductPriceParams!) {
  removeProductPrice(removeProductPriceParams: $removeProductPriceParams)
}

Variables

{"removeProductPriceParams": RemoveProductPriceParams}

Response

{"data": {"removeProductPrice": true}}

Mutations

`removeShoppingCartLineItems`

Description

Removes specified line items from a shopping cart.

Response

Returns a ShoppingCart!

Arguments

Name	Description
`removeShoppingCartLineItemsParams` - `RemoveShoppingCartLineItemsParams!`

Example

Query

mutation removeShoppingCartLineItems($removeShoppingCartLineItemsParams: RemoveShoppingCartLineItemsParams!) {
  removeShoppingCartLineItems(removeShoppingCartLineItemsParams: $removeShoppingCartLineItemsParams) {
    status
    id
    externalId
    anonymousId
    subtotalAmount
    totalAmount
    lineItemList {
      ...ShoppingCartLineItemFragment
    }
    shippingAddress {
      ...ShoppingCartShippingAddressFragment
    }
    discountCoupon {
      ...DiscountCouponResultFragment
    }
    discountAmount
    customer {
      ...ShoppingCartCustomerFragment
    }
    createdAt
    updatedAt
    activeDiscount {
      ...ShoppingCartActiveDiscountFragment
    }
    costs {
      ...ShoppingCartCostFragment
    }
  }
}

Variables

{
  "removeShoppingCartLineItemsParams": RemoveShoppingCartLineItemsParams
}

Response

{
  "data": {
    "removeShoppingCartLineItems": {
      "status": "OPEN",
      "id": 987,
      "externalId": "xyz789",
      "anonymousId": "abc123",
      "subtotalAmount": 987,
      "totalAmount": 987,
      "lineItemList": [ShoppingCartLineItem],
      "shippingAddress": ShoppingCartShippingAddress,
      "discountCoupon": DiscountCouponResult,
      "discountAmount": 987,
      "customer": ShoppingCartCustomer,
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03",
      "activeDiscount": ShoppingCartActiveDiscount,
      "costs": ShoppingCartCost
    }
  }
}

Mutations

`requestBoxCancellation`

Response

Returns a RequestBoxCancellationResponse!

Arguments

Name	Description
`requestBoxCancellationParams` - `RequestBoxCancellationParams!`

Example

Query

mutation requestBoxCancellation($requestBoxCancellationParams: RequestBoxCancellationParams!) {
  requestBoxCancellation(requestBoxCancellationParams: $requestBoxCancellationParams) {
    order {
      ...OrderFragment
    }
    boxCancellationRequests {
      ...CancellationRequestFragment
    }
    boxes {
      ...BoxFragment
    }
    trackingDetails {
      ...TrackingDetailFragment
    }
  }
}

Variables

{
  "requestBoxCancellationParams": RequestBoxCancellationParams
}

Response

{
  "data": {
    "requestBoxCancellation": {
      "order": Order,
      "boxCancellationRequests": [CancellationRequest],
      "boxes": [Box],
      "trackingDetails": [TrackingDetail]
    }
  }
}

Mutations

`reschedulePickUp`

Response

Returns a ReschedulePickUpResponse!

Arguments

Name	Description
`reschedulePickUpParams` - `ReschedulePickUpParams!`

Example

Query

mutation reschedulePickUp($reschedulePickUpParams: ReschedulePickUpParams!) {
  reschedulePickUp(reschedulePickUpParams: $reschedulePickUpParams) {
    trackingDetails {
      ...TrackingDetailFragment
    }
  }
}

Variables

{"reschedulePickUpParams": ReschedulePickUpParams}

Response

{
  "data": {
    "reschedulePickUp": {
      "trackingDetails": [TrackingDetail]
    }
  }
}

Mutations

`resetSignUp`

Response

Returns a Boolean!

Arguments

Name	Description
`resetSignUpParams` - `ResetSignUpParams!`

Example

Query

mutation resetSignUp($resetSignUpParams: ResetSignUpParams!) {
  resetSignUp(resetSignUpParams: $resetSignUpParams)
}

Variables

{"resetSignUpParams": ResetSignUpParams}

Response

{"data": {"resetSignUp": true}}

Mutations

`retrieveBoxes`

Response

Returns a RetrieveBoxesResponse!

Arguments

Name	Description
`retrieveBoxesParams` - `RetrieveBoxesParams!`

Example

Query

mutation retrieveBoxes($retrieveBoxesParams: RetrieveBoxesParams!) {
  retrieveBoxes(retrieveBoxesParams: $retrieveBoxesParams) {
    orders {
      ...OrderFragment
    }
  }
}

Variables

{"retrieveBoxesParams": RetrieveBoxesParams}

Response

{"data": {"retrieveBoxes": {"orders": [Order]}}}

Mutations

`scanBox`

Response

Returns a ScanBoxResponse!

Arguments

Name	Description
`scanBoxParams` - `ScanBoxParams!`

Example

Query

mutation scanBox($scanBoxParams: ScanBoxParams!) {
  scanBox(scanBoxParams: $scanBoxParams) {
    box {
      ...BoxFragment
    }
  }
}

Variables

{"scanBoxParams": ScanBoxParams}

Response

{"data": {"scanBox": {"box": Box}}}

Mutations

`setDefaultPaymentMethod`

Response

Returns a Boolean!

Arguments

Name	Description
`setDefaultPaymentMethodParams` - `SetDefaultPaymentMethodParams!`

Example

Query

mutation setDefaultPaymentMethod($setDefaultPaymentMethodParams: SetDefaultPaymentMethodParams!) {
  setDefaultPaymentMethod(setDefaultPaymentMethodParams: $setDefaultPaymentMethodParams)
}

Variables

{
  "setDefaultPaymentMethodParams": SetDefaultPaymentMethodParams
}

Response

{"data": {"setDefaultPaymentMethod": true}}

Mutations

`setFirstScannedAt`

Response

Returns a SetFirstScannedAtResponse!

Arguments

Name	Description
`setFirstScannedAtParams` - `SetFirstScannedAtParams!`

Example

Query

mutation setFirstScannedAt($setFirstScannedAtParams: SetFirstScannedAtParams!) {
  setFirstScannedAt(setFirstScannedAtParams: $setFirstScannedAtParams) {
    box {
      ...BoxFragment
    }
  }
}

Variables

{"setFirstScannedAtParams": SetFirstScannedAtParams}

Response

{"data": {"setFirstScannedAt": {"box": Box}}}

Mutations

`setShoppingCartDiscountCoupon`

Description

Applies a discount coupon to a shopping cart. To remove a coupon, set the couponCode to null.

Response

Returns a ShoppingCart!

Arguments

Name	Description
`setShoppingCartDiscountCouponParams` - `SetShoppingCartDiscountCouponParams!`

Example

Query

mutation setShoppingCartDiscountCoupon($setShoppingCartDiscountCouponParams: SetShoppingCartDiscountCouponParams!) {
  setShoppingCartDiscountCoupon(setShoppingCartDiscountCouponParams: $setShoppingCartDiscountCouponParams) {
    status
    id
    externalId
    anonymousId
    subtotalAmount
    totalAmount
    lineItemList {
      ...ShoppingCartLineItemFragment
    }
    shippingAddress {
      ...ShoppingCartShippingAddressFragment
    }
    discountCoupon {
      ...DiscountCouponResultFragment
    }
    discountAmount
    customer {
      ...ShoppingCartCustomerFragment
    }
    createdAt
    updatedAt
    activeDiscount {
      ...ShoppingCartActiveDiscountFragment
    }
    costs {
      ...ShoppingCartCostFragment
    }
  }
}

Variables

{
  "setShoppingCartDiscountCouponParams": SetShoppingCartDiscountCouponParams
}

Response

{
  "data": {
    "setShoppingCartDiscountCoupon": {
      "status": "OPEN",
      "id": 987,
      "externalId": "xyz789",
      "anonymousId": "abc123",
      "subtotalAmount": 987,
      "totalAmount": 123,
      "lineItemList": [ShoppingCartLineItem],
      "shippingAddress": ShoppingCartShippingAddress,
      "discountCoupon": DiscountCouponResult,
      "discountAmount": 123,
      "customer": ShoppingCartCustomer,
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03",
      "activeDiscount": ShoppingCartActiveDiscount,
      "costs": ShoppingCartCost
    }
  }
}

Mutations

`setShoppingCartShippingAddress`

Description

Sets the shipping address for a shopping cart.

Response

Returns a ShoppingCart!

Arguments

Name	Description
`setShoppingCartShippingAddressParams` - `SetShoppingCartShippingAddressParams!`

Example

Query

mutation setShoppingCartShippingAddress($setShoppingCartShippingAddressParams: SetShoppingCartShippingAddressParams!) {
  setShoppingCartShippingAddress(setShoppingCartShippingAddressParams: $setShoppingCartShippingAddressParams) {
    status
    id
    externalId
    anonymousId
    subtotalAmount
    totalAmount
    lineItemList {
      ...ShoppingCartLineItemFragment
    }
    shippingAddress {
      ...ShoppingCartShippingAddressFragment
    }
    discountCoupon {
      ...DiscountCouponResultFragment
    }
    discountAmount
    customer {
      ...ShoppingCartCustomerFragment
    }
    createdAt
    updatedAt
    activeDiscount {
      ...ShoppingCartActiveDiscountFragment
    }
    costs {
      ...ShoppingCartCostFragment
    }
  }
}

Variables

{
  "setShoppingCartShippingAddressParams": SetShoppingCartShippingAddressParams
}

Response

{
  "data": {
    "setShoppingCartShippingAddress": {
      "status": "OPEN",
      "id": 987,
      "externalId": "xyz789",
      "anonymousId": "xyz789",
      "subtotalAmount": 123,
      "totalAmount": 123,
      "lineItemList": [ShoppingCartLineItem],
      "shippingAddress": ShoppingCartShippingAddress,
      "discountCoupon": DiscountCouponResult,
      "discountAmount": 987,
      "customer": ShoppingCartCustomer,
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03",
      "activeDiscount": ShoppingCartActiveDiscount,
      "costs": ShoppingCartCost
    }
  }
}

Mutations

`signUp`

Response

Returns a SignUpResponse!

Arguments

Name	Description
`signUpParams` - `SignUpParams!`

Example

Query

mutation signUp($signUpParams: SignUpParams!) {
  signUp(signUpParams: $signUpParams) {
    customer {
      ...CustomerFragment
    }
  }
}

Variables

{"signUpParams": SignUpParams}

Response

{"data": {"signUp": {"customer": Customer}}}

Mutations

`storeBox`

Response

Returns a StoreBoxResponse!

Arguments

Name	Description
`storeBoxParams` - `StoreBoxParams!`

Example

Query

mutation storeBox($storeBoxParams: StoreBoxParams!) {
  storeBox(storeBoxParams: $storeBoxParams) {
    box {
      ...BoxFragment
    }
  }
}

Variables

{"storeBoxParams": StoreBoxParams}

Response

{"data": {"storeBox": {"box": Box}}}

Mutations

`toggleWarehouseSpotsStatuses`

Response

Returns a Boolean!

Arguments

Name	Description
`toggleWarehouseSpotsStatusesParams` - `ToggleWarehouseSpotsStatusesParams!`

Example

Query

mutation toggleWarehouseSpotsStatuses($toggleWarehouseSpotsStatusesParams: ToggleWarehouseSpotsStatusesParams!) {
  toggleWarehouseSpotsStatuses(toggleWarehouseSpotsStatusesParams: $toggleWarehouseSpotsStatusesParams)
}

Variables

{
  "toggleWarehouseSpotsStatusesParams": ToggleWarehouseSpotsStatusesParams
}

Response

{"data": {"toggleWarehouseSpotsStatuses": true}}

Mutations

`unarchiveWarehouse`

Response

Returns a Boolean!

Arguments

Name	Description
`unarchiveWarehouseParams` - `UnarchiveWarehouseParams!`

Example

Query

mutation unarchiveWarehouse($unarchiveWarehouseParams: UnarchiveWarehouseParams!) {
  unarchiveWarehouse(unarchiveWarehouseParams: $unarchiveWarehouseParams)
}

Variables

{"unarchiveWarehouseParams": UnarchiveWarehouseParams}

Response

{"data": {"unarchiveWarehouse": false}}

Mutations

`unlockBox`

Response

Returns an UnlockBoxResponse!

Arguments

Name	Description
`unlockBoxParams` - `UnlockBoxParams!`

Example

Query

mutation unlockBox($unlockBoxParams: UnlockBoxParams!) {
  unlockBox(unlockBoxParams: $unlockBoxParams) {
    box {
      ...BoxFragment
    }
  }
}

Variables

{"unlockBoxParams": UnlockBoxParams}

Response

{"data": {"unlockBox": {"box": Box}}}

Mutations

`updateAdminUser`

Response

Returns an UpdateAdminUserResponse!

Arguments

Name	Description
`updateAdminUserParams` - `UpdateAdminUserParams!`

Example

Query

mutation updateAdminUser($updateAdminUserParams: UpdateAdminUserParams!) {
  updateAdminUser(updateAdminUserParams: $updateAdminUserParams) {
    admin {
      ...AdminFragment
    }
  }
}

Variables

{"updateAdminUserParams": UpdateAdminUserParams}

Response

{"data": {"updateAdminUser": {"admin": Admin}}}

Mutations

`updateApiKey`

Response

Returns an UpdateApiKeyResponse!

Arguments

Name	Description
`updateApiKeyParams` - `UpdateApiKeyParams!`

Example

Query

mutation updateApiKey($updateApiKeyParams: UpdateApiKeyParams!) {
  updateApiKey(updateApiKeyParams: $updateApiKeyParams) {
    apiKey {
      ...ApiKeyFragment
    }
  }
}

Variables

{"updateApiKeyParams": UpdateApiKeyParams}

Response

{"data": {"updateApiKey": {"apiKey": ApiKey}}}

Mutations

`updateAppConfigurableParameters`

Response

Returns a JSON!

Arguments

Name	Description
`updateAppConfigurableParametersParams` - `JSON!`

Example

Query

mutation updateAppConfigurableParameters($updateAppConfigurableParametersParams: JSON!) {
  updateAppConfigurableParameters(updateAppConfigurableParametersParams: $updateAppConfigurableParametersParams)
}

Variables

{"updateAppConfigurableParametersParams": {}}

Response

{"data": {"updateAppConfigurableParameters": {}}}

Mutations

`updateBox`

Response

Returns an UpdateBoxResponse!

Arguments

Name	Description
`updateBoxParams` - `UpdateBoxParams!`

Example

Query

mutation updateBox($updateBoxParams: UpdateBoxParams!) {
  updateBox(updateBoxParams: $updateBoxParams) {
    box {
      ...BoxFragment
    }
  }
}

Variables

{"updateBoxParams": UpdateBoxParams}

Response

{"data": {"updateBox": {"box": Box}}}

Mutations

`updateBoxLocation`

Response

Returns an UpdateBoxLocationResponse!

Arguments

Name	Description
`updateBoxLocationParams` - `UpdateBoxLocationParams!`

Example

Query

mutation updateBoxLocation($updateBoxLocationParams: UpdateBoxLocationParams!) {
  updateBoxLocation(updateBoxLocationParams: $updateBoxLocationParams) {
    box {
      ...BoxFragment
    }
  }
}

Variables

{"updateBoxLocationParams": UpdateBoxLocationParams}

Response

{"data": {"updateBoxLocation": {"box": Box}}}

Mutations

`updateBoxType`

Response

Returns an UpdateBoxTypeResponse!

Arguments

Name	Description
`updateBoxTypeParams` - `UpdateBoxTypeParams!`

Example

Query

mutation updateBoxType($updateBoxTypeParams: UpdateBoxTypeParams!) {
  updateBoxType(updateBoxTypeParams: $updateBoxTypeParams) {
    boxType {
      ...BoxTypeFragment
    }
  }
}

Variables

{"updateBoxTypeParams": UpdateBoxTypeParams}

Response

{"data": {"updateBoxType": {"boxType": BoxType}}}

Mutations

`updateConfigurableParameter`

Response

Returns an UpdateConfigurableParameterResponse!

Arguments

Name	Description
`updateConfigurableParameterParams` - `UpdateConfigurableParameterParams!`

Example

Query

mutation updateConfigurableParameter($updateConfigurableParameterParams: UpdateConfigurableParameterParams!) {
  updateConfigurableParameter(updateConfigurableParameterParams: $updateConfigurableParameterParams) {
    configurableParameter {
      ...ConfigurableParameterFragment
    }
  }
}

Variables

{
  "updateConfigurableParameterParams": UpdateConfigurableParameterParams
}

Response

{
  "data": {
    "updateConfigurableParameter": {
      "configurableParameter": ConfigurableParameter
    }
  }
}

Mutations

`updateCustomer`

Response

Returns an UpdateCustomerResponse!

Arguments

Name	Description
`updateCustomerParams` - `UpdateCustomerParams!`

Example

Query

mutation updateCustomer($updateCustomerParams: UpdateCustomerParams!) {
  updateCustomer(updateCustomerParams: $updateCustomerParams) {
    customer {
      ...CustomerFragment
    }
  }
}

Variables

{"updateCustomerParams": UpdateCustomerParams}

Response

{"data": {"updateCustomer": {"customer": Customer}}}

Mutations

`updateCustomerAddress`

Response

Returns an UpdateCustomerAddressResponse!

Arguments

Name	Description
`updateCustomerAddressParams` - `UpdateCustomerAddressParams!`

Example

Query

mutation updateCustomerAddress($updateCustomerAddressParams: UpdateCustomerAddressParams!) {
  updateCustomerAddress(updateCustomerAddressParams: $updateCustomerAddressParams) {
    address {
      ...CustomerAddressFragment
    }
  }
}

Variables

{
  "updateCustomerAddressParams": UpdateCustomerAddressParams
}

Response

{
  "data": {
    "updateCustomerAddress": {"address": CustomerAddress}
  }
}

Mutations

`updateCustomerGroup`

Response

Returns an UpdateCustomerGroupResponse!

Arguments

Name	Description
`updateCustomerGroupParams` - `UpdateCustomerGroupParams!`

Example

Query

mutation updateCustomerGroup($updateCustomerGroupParams: UpdateCustomerGroupParams!) {
  updateCustomerGroup(updateCustomerGroupParams: $updateCustomerGroupParams) {
    customerGroup {
      ...CustomerGroupFragment
    }
  }
}

Variables

{"updateCustomerGroupParams": UpdateCustomerGroupParams}

Response

{
  "data": {
    "updateCustomerGroup": {
      "customerGroup": CustomerGroup
    }
  }
}

Mutations

`updateDiscountCoupon`

Response

Returns a DiscountCouponResult!

Arguments

Name	Description
`updateDiscountCouponParams` - `UpdateDiscountCouponParams!`

Example

Query

mutation updateDiscountCoupon($updateDiscountCouponParams: UpdateDiscountCouponParams!) {
  updateDiscountCoupon(updateDiscountCouponParams: $updateDiscountCouponParams) {
    id
    code
    type
    amount
    limit
    usage
    startDate
    endDate
    createdAt
    updatedAt
    status
    minimumPurchaseAmount
    maximumPurchaseAmount
    isUnlimited
    minimumBoxesAmount
    applyToRecurrentPayments
    firstPurchaseOnly
    usageLimitPerCustomer
    recurringBillingCyclesLimit
  }
}

Variables

{"updateDiscountCouponParams": UpdateDiscountCouponParams}

Response

{
  "data": {
    "updateDiscountCoupon": {
      "id": 123,
      "code": "xyz789",
      "type": "xyz789",
      "amount": 123.45,
      "limit": 123,
      "usage": 987,
      "startDate": "2007-12-03",
      "endDate": "2007-12-03",
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03",
      "status": "xyz789",
      "minimumPurchaseAmount": 123,
      "maximumPurchaseAmount": 123,
      "isUnlimited": false,
      "minimumBoxesAmount": 123,
      "applyToRecurrentPayments": false,
      "firstPurchaseOnly": true,
      "usageLimitPerCustomer": 123,
      "recurringBillingCyclesLimit": 987
    }
  }
}

Mutations

`updateNote`

Response

Returns an UpdateNoteResponse!

Arguments

Name	Description
`updateNoteParams` - `UpdateNoteParams!`

Example

Query

mutation updateNote($updateNoteParams: UpdateNoteParams!) {
  updateNote(updateNoteParams: $updateNoteParams) {
    note {
      ...NoteFragment
    }
  }
}

Variables

{"updateNoteParams": UpdateNoteParams}

Response

{"data": {"updateNote": {"note": Note}}}

Mutations

`updateOrderShippingAddress`

Response

Returns an UpdateOrderShippingAddressResponse!

Arguments

Name	Description
`updateOrderShippingAddressParams` - `UpdateOrderShippingAddressParams!`

Example

Query

mutation updateOrderShippingAddress($updateOrderShippingAddressParams: UpdateOrderShippingAddressParams!) {
  updateOrderShippingAddress(updateOrderShippingAddressParams: $updateOrderShippingAddressParams) {
    order {
      ...OrderFragment
    }
  }
}

Variables

{
  "updateOrderShippingAddressParams": UpdateOrderShippingAddressParams
}

Response

{"data": {"updateOrderShippingAddress": {"order": Order}}}

Mutations

`updateOrderShippingDetail`

Response

Returns an OrderShippingDetail!

Arguments

Name	Description
`updateOrderShippingDetailParams` - `UpdateOrderShippingDetailParams!`

Example

Query

mutation updateOrderShippingDetail($updateOrderShippingDetailParams: UpdateOrderShippingDetailParams!) {
  updateOrderShippingDetail(updateOrderShippingDetailParams: $updateOrderShippingDetailParams) {
    id
    orderId
    trackingNumber
    labelUrl
    type
    status
    serviceType
    serviceName
    priceInCents
    shippedAt
    estimatedDeliveryDate
    deliveredAt
    scheduledAt
    customerCloseTime
    notes
    instructions
    confirmationCode
    printedAt
    directSignatureRequired
    expectedDeliveryDate
    recommendedShippingDate
    createdAt
    updatedAt
  }
}

Variables

{
  "updateOrderShippingDetailParams": UpdateOrderShippingDetailParams
}

Response

{
  "data": {
    "updateOrderShippingDetail": {
      "id": 987,
      "orderId": 123,
      "trackingNumber": "xyz789",
      "labelUrl": "abc123",
      "type": 123,
      "status": 987,
      "serviceType": "abc123",
      "serviceName": "abc123",
      "priceInCents": 123,
      "shippedAt": "2007-12-03",
      "estimatedDeliveryDate": "2007-12-03",
      "deliveredAt": "2007-12-03",
      "scheduledAt": "2007-12-03",
      "customerCloseTime": "xyz789",
      "notes": "xyz789",
      "instructions": "xyz789",
      "confirmationCode": "xyz789",
      "printedAt": "2007-12-03",
      "directSignatureRequired": false,
      "expectedDeliveryDate": "2007-12-03",
      "recommendedShippingDate": "2007-12-03",
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03"
    }
  }
}

Mutations

`updateProduct`

Response

Returns an UpdateProductResponse!

Arguments

Name	Description
`updateProductParams` - `UpdateProductParams!`

Example

Query

mutation updateProduct($updateProductParams: UpdateProductParams!) {
  updateProduct(updateProductParams: $updateProductParams) {
    product {
      ...ProductFragment
    }
  }
}

Variables

{"updateProductParams": UpdateProductParams}

Response

{"data": {"updateProduct": {"product": Product}}}

Mutations

`updateProductPrice`

Response

Returns a ProductPrice!

Arguments

Name	Description
`updateProductPriceParams` - `UpdateProductPriceParams!`

Example

Query

mutation updateProductPrice($updateProductPriceParams: UpdateProductPriceParams!) {
  updateProductPrice(updateProductPriceParams: $updateProductPriceParams) {
    id
    productId
    status
    purchaseAmount
    recurrentAmount
    currency
    minStoragePeriodAmount
    minStoragePeriodUnit
    includedStoragePeriodAmount
    includedStoragePeriodUnit
    isDefault
    validFrom
    validUntil
    promotionName
    createdAt
    updatedAt
  }
}

Variables

{"updateProductPriceParams": UpdateProductPriceParams}

Response

{
  "data": {
    "updateProductPrice": {
      "id": 123,
      "productId": 123,
      "status": 123,
      "purchaseAmount": 123,
      "recurrentAmount": 987,
      "currency": "USD",
      "minStoragePeriodAmount": 123,
      "minStoragePeriodUnit": 123,
      "includedStoragePeriodAmount": 123,
      "includedStoragePeriodUnit": 987,
      "isDefault": false,
      "validFrom": "2007-12-03",
      "validUntil": "2007-12-03",
      "promotionName": "xyz789",
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03"
    }
  }
}

Mutations

`updateProducts`

Response

Returns [Product!]!

Arguments

Name	Description
`updateProductsParams` - `[UpdateProductsParams]!`

Example

Query

mutation updateProducts($updateProductsParams: [UpdateProductsParams]!) {
  updateProducts(updateProductsParams: $updateProductsParams) {
    id
    sku
    status
    title
    description
    shortDescription
    urlKey
    seoTitle
    seoDescription
    seoKeywords
    boxTypeId
    quantity
    boxQuantity
    type
    isMostPopular
    isStarterKit
    createdAt
    updatedAt
    boxType {
      ...BoxTypeFragment
    }
    priceList {
      ...ProductPriceFragment
    }
    activePrice {
      ...ProductPriceFragment
    }
    defaultPrice {
      ...ProductPriceFragment
    }
    imageList {
      ...ProductImageFragment
    }
    price
    images
    priceTierQuantityRules {
      ...PriceTierQuantityRulesFragment
    }
  }
}

Variables

{"updateProductsParams": [UpdateProductsParams]}

Response

{
  "data": {
    "updateProducts": [
      {
        "id": 987,
        "sku": "xyz789",
        "status": 123,
        "title": "abc123",
        "description": "xyz789",
        "shortDescription": "abc123",
        "urlKey": "xyz789",
        "seoTitle": "xyz789",
        "seoDescription": "abc123",
        "seoKeywords": "abc123",
        "boxTypeId": 987,
        "quantity": 987,
        "boxQuantity": 123,
        "type": 987,
        "isMostPopular": true,
        "isStarterKit": false,
        "createdAt": "2007-12-03",
        "updatedAt": "2007-12-03",
        "boxType": BoxType,
        "priceList": [ProductPrice],
        "activePrice": ProductPrice,
        "defaultPrice": ProductPrice,
        "imageList": [ProductImage],
        "price": 987.65,
        "images": {},
        "priceTierQuantityRules": [PriceTierQuantityRules]
      }
    ]
  }
}

Mutations

`updateShoppingCartLineItemsQuantity`

Description

Updates the quantity of specified line items in a shopping cart.

Response

Returns a ShoppingCart!

Arguments

Name	Description
`updateShoppingCartLineItemsQuantityParams` - `UpdateShoppingCartLineItemsQuantityParams!`

Example

Query

mutation updateShoppingCartLineItemsQuantity($updateShoppingCartLineItemsQuantityParams: UpdateShoppingCartLineItemsQuantityParams!) {
  updateShoppingCartLineItemsQuantity(updateShoppingCartLineItemsQuantityParams: $updateShoppingCartLineItemsQuantityParams) {
    status
    id
    externalId
    anonymousId
    subtotalAmount
    totalAmount
    lineItemList {
      ...ShoppingCartLineItemFragment
    }
    shippingAddress {
      ...ShoppingCartShippingAddressFragment
    }
    discountCoupon {
      ...DiscountCouponResultFragment
    }
    discountAmount
    customer {
      ...ShoppingCartCustomerFragment
    }
    createdAt
    updatedAt
    activeDiscount {
      ...ShoppingCartActiveDiscountFragment
    }
    costs {
      ...ShoppingCartCostFragment
    }
  }
}

Variables

{
  "updateShoppingCartLineItemsQuantityParams": UpdateShoppingCartLineItemsQuantityParams
}

Response

{
  "data": {
    "updateShoppingCartLineItemsQuantity": {
      "status": "OPEN",
      "id": 123,
      "externalId": "xyz789",
      "anonymousId": "abc123",
      "subtotalAmount": 987,
      "totalAmount": 123,
      "lineItemList": [ShoppingCartLineItem],
      "shippingAddress": ShoppingCartShippingAddress,
      "discountCoupon": DiscountCouponResult,
      "discountAmount": 987,
      "customer": ShoppingCartCustomer,
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03",
      "activeDiscount": ShoppingCartActiveDiscount,
      "costs": ShoppingCartCost
    }
  }
}

Mutations

`updateTrackingDetail`

Response

Returns a TrackingDetail!

Arguments

Name	Description
`updateTrackingDetailParams` - `UpdateTrackingDetailParams!`

Example

Query

mutation updateTrackingDetail($updateTrackingDetailParams: UpdateTrackingDetailParams!) {
  updateTrackingDetail(updateTrackingDetailParams: $updateTrackingDetailParams) {
    id
    boxId
    trackingNumber
    type
    status
    shippedAt
    estimatedDeliveryDate
    deliveredAt
    scheduledAt
    customerCloseTime
    notes
    instructions
    confirmationCode
    createdAt
    updatedAt
    addresses {
      ...TrackingDetailAddressFragment
    }
    warehouseId
    scheduledAtInUtc
    customerCloseTimeInUtc
  }
}

Variables

{"updateTrackingDetailParams": UpdateTrackingDetailParams}

Response

{
  "data": {
    "updateTrackingDetail": {
      "id": 123,
      "boxId": 123,
      "trackingNumber": "xyz789",
      "type": 123,
      "status": 123,
      "shippedAt": "2007-12-03",
      "estimatedDeliveryDate": "2007-12-03",
      "deliveredAt": "2007-12-03",
      "scheduledAt": "2007-12-03",
      "customerCloseTime": "xyz789",
      "notes": "abc123",
      "instructions": "abc123",
      "confirmationCode": "xyz789",
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03",
      "addresses": [TrackingDetailAddress],
      "warehouseId": 123,
      "scheduledAtInUtc": "2007-12-03",
      "customerCloseTimeInUtc": "2007-12-03"
    }
  }
}

Mutations

`updateWarehouse`

Response

Returns an UpdateWarehouseResponse!

Arguments

Name	Description
`updateWarehouseParams` - `UpdateWarehouseParams!`

Example

Query

mutation updateWarehouse($updateWarehouseParams: UpdateWarehouseParams!) {
  updateWarehouse(updateWarehouseParams: $updateWarehouseParams) {
    warehouse {
      ...WarehouseFragment
    }
  }
}

Variables

{"updateWarehouseParams": UpdateWarehouseParams}

Response

{"data": {"updateWarehouse": {"warehouse": Warehouse}}}

Mutations

`updateWarehouseSpot`

Response

Returns an UpdateWarehouseSpotResponse!

Arguments

Name	Description
`updateWarehouseSpotParams` - `UpdateWarehouseSpotParams!`

Example

Query

mutation updateWarehouseSpot($updateWarehouseSpotParams: UpdateWarehouseSpotParams!) {
  updateWarehouseSpot(updateWarehouseSpotParams: $updateWarehouseSpotParams) {
    warehouseSpot {
      ...WarehouseSpotFragment
    }
  }
}

Variables

{"updateWarehouseSpotParams": UpdateWarehouseSpotParams}

Response

{
  "data": {
    "updateWarehouseSpot": {
      "warehouseSpot": WarehouseSpot
    }
  }
}

Subscriptions

`billingFrequencyInMonths`

Response

Returns an Int

Example

Query

subscription billingFrequencyInMonths {
  billingFrequencyInMonths
}

Response

{"data": {"billingFrequencyInMonths": 987}}

Subscriptions

`cancelAtPeriodEnd`

Response

Returns a Boolean

Example

Query

subscription cancelAtPeriodEnd {
  cancelAtPeriodEnd
}

Response

{"data": {"cancelAtPeriodEnd": true}}

Subscriptions

`cancellationRequestedAt`

Response

Returns a Date

Example

Query

subscription cancellationRequestedAt {
  cancellationRequestedAt
}

Response

{
  "data": {
    "cancellationRequestedAt": "2007-12-03"
  }
}

Subscriptions

`cancelledAt`

Response

Returns a Date

Example

Query

subscription cancelledAt {
  cancelledAt
}

Response

{"data": {"cancelledAt": "2007-12-03"}}

Subscriptions

`createdAt`

Response

Returns a Date

Example

Query

subscription createdAt {
  createdAt
}

Response

{"data": {"createdAt": "2007-12-03"}}

Subscriptions

`currentTermEndDate`

Response

Returns a Date

Example

Query

subscription currentTermEndDate {
  currentTermEndDate
}

Response

{
  "data": {
    "currentTermEndDate": "2007-12-03"
  }
}

Subscriptions

`currentTermStartDate`

Response

Returns a Date

Example

Query

subscription currentTermStartDate {
  currentTermStartDate
}

Response

{
  "data": {
    "currentTermStartDate": "2007-12-03"
  }
}

Subscriptions

`customerId`

Response

Returns an Int

Example

Query

subscription customerId {
  customerId
}

Response

{"data": {"customerId": 123}}

Subscriptions

`id`

Response

Returns an Int

Example

Query

subscription id {
  id
}

Response

{"data": {"id": 123}}

Subscriptions

`lastBillingDate`

Response

Returns a Date

Example

Query

subscription lastBillingDate {
  lastBillingDate
}

Response

{"data": {"lastBillingDate": "2007-12-03"}}

Subscriptions

`minimumSubscriptionEndDate`

Response

Returns a Date

Example

Query

subscription minimumSubscriptionEndDate {
  minimumSubscriptionEndDate
}

Response

{
  "data": {
    "minimumSubscriptionEndDate": "2007-12-03"
  }
}

Subscriptions

`nextBillingDate`

Response

Returns a Date

Example

Query

subscription nextBillingDate {
  nextBillingDate
}

Response

{"data": {"nextBillingDate": "2007-12-03"}}

Subscriptions

`renewalFrequencyInMonths`

Response

Returns an Int

Example

Query

subscription renewalFrequencyInMonths {
  renewalFrequencyInMonths
}

Response

{"data": {"renewalFrequencyInMonths": 987}}

Subscriptions

`status`

Response

Returns a SubscriptionStatus

Example

Query

subscription status {
  status
}

Response

{"data": {"status": "ACTIVE"}}

Subscriptions

`subscriptionPlan`

Response

Returns a SubscriptionPlan

Example

Query

subscription subscriptionPlan {
  subscriptionPlan {
    id
    name
    description
    status
    billingFrequency
    billingFrequencyInMonths
    renewalFrequency
    renewalFrequencyInMonths
    minDurationInMonths
    createdAt
    updatedAt
  }
}

Response

{
  "data": {
    "subscriptionPlan": {
      "id": 987,
      "name": "abc123",
      "description": "abc123",
      "status": "ACTIVE",
      "billingFrequency": "MONTHLY",
      "billingFrequencyInMonths": 987,
      "renewalFrequency": "MONTHLY",
      "renewalFrequencyInMonths": 987,
      "minDurationInMonths": 123,
      "createdAt": "2007-12-03",
      "updatedAt": "2007-12-03"
    }
  }
}

Subscriptions

`subscriptionPlanId`

Response

Returns an Int

Example

Query

subscription subscriptionPlanId {
  subscriptionPlanId
}

Response

{"data": {"subscriptionPlanId": 123}}

Subscriptions

`subscriptionStartDate`

Response

Returns a Date

Example

Query

subscription subscriptionStartDate {
  subscriptionStartDate
}

Response

{
  "data": {
    "subscriptionStartDate": "2007-12-03"
  }
}

Subscriptions

`updatedAt`

Response

Returns a Date

Example

Query

subscription updatedAt {
  updatedAt
}

Response

{"data": {"updatedAt": "2007-12-03"}}

Types

AcceptMembershipCancellationRequestParams

Fields

Input Field	Description
`customerId` - `Int!`

Example

{"customerId": 123}

Types

AcceptMembershipCancellationRequestResponse

Fields

Field Name	Description
`success` - `Boolean!`

Example

{"success": true}

Types

AcknowledgeBoxPackingParams

Fields

Input Field	Description
`id` - `Int!`	Box ID

Example

{"id": 123}

Types

AcknowledgeBoxPackingResponse

Fields

Field Name	Description
`box` - `Box!`

Example

{"box": Box}

Types

AddApplePayPaymentMethodParams

Fields

Input Field	Description
`paymentMethodNonce` - `String!`

Example

{"paymentMethodNonce": "abc123"}

Types

AddApplePayPaymentMethodResponse

Fields

Field Name	Description
`creditCard` - `CustomerCreditCard`

Example

{"creditCard": CustomerCreditCard}

Types

AddProductPriceParams

Fields

Input Field	Description
`price` - `ProductPriceInput!`

Example

{"price": ProductPriceInput}

Types

AddShoppingCartLineItemParams

Fields

Input Field	Description
`productId` - `Int!`
`quantity` - `Int!`

Example

{"productId": 987, "quantity": 987}

Types

AddShoppingCartLineItemsParams

Fields

Input Field	Description
`externalId` - `String`
`cartId` - `Int`	(Deprecated) Use externalId instead of cartId
`items` - `[AddShoppingCartLineItemParams!]!`

Example

{
  "externalId": "abc123",
  "cartId": 987,
  "items": [AddShoppingCartLineItemParams]
}

Types

AddressInput

Fields

Input Field	Description
`street1` - `String!`
`street2` - `String`
`city` - `String!`
`state` - `String!`
`zipcode` - `String!`
`country` - `String!`
`residential` - `Boolean`
`instructions` - `String`

Example

{
  "street1": "xyz789",
  "street2": "xyz789",
  "city": "abc123",
  "state": "xyz789",
  "zipcode": "xyz789",
  "country": "abc123",
  "residential": false,
  "instructions": "xyz789"
}

Types

Admin

Fields

Field Name	Description
`id` - `Int`
`firstName` - `String`
`lastName` - `String`
`email` - `String`
`phone` - `String`
`roles` - `[String]`
`warehouses` - `[Warehouse]`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 123,
  "firstName": "xyz789",
  "lastName": "abc123",
  "email": "abc123",
  "phone": "abc123",
  "roles": ["xyz789"],
  "warehouses": [Warehouse],
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

AdminCancelBoxParams

Fields

Input Field	Description
`boxId` - `Int!`
`reason` - `String!`
`mustRemoveWarehouseSpotAssignment` - `Boolean!`

Example

{
  "boxId": 123,
  "reason": "abc123",
  "mustRemoveWarehouseSpotAssignment": true
}

Types

AdminCancelPickUpParams

Fields

Input Field	Description
`pickUpId` - `Int!`

Example

{"pickUpId": 987}

Types

AdminCheckPickUpAvailabilityParams

Fields

Input Field	Description
`boxId` - `Int!`
`pickUpAddress` - `PickUpAddress!`
`dispatchDate` - `String`

Example

{
  "boxId": 123,
  "pickUpAddress": PickUpAddress,
  "dispatchDate": "abc123"
}

Types

AdminCheckPickUpAvailabilityResponse

Fields

Field Name	Description
`options` - `[CheckPickUpAvailabilityOption]`

Example

{"options": [CheckPickUpAvailabilityOption]}

Types

AdminCreatePickUpsParams

Fields

Input Field	Description
`boxIds` - `[Int!]!`
`scheduledAt` - `String!`
`customerCloseTime` - `String!`
`pickUpAddress` - `PickUpAddress!`
`instructions` - `String`

Example

{
  "boxIds": [123],
  "scheduledAt": "abc123",
  "customerCloseTime": "abc123",
  "pickUpAddress": PickUpAddress,
  "instructions": "xyz789"
}

Types

AdminCreatePickUpsResponse

Fields

Field Name	Description
`trackingDetails` - `[TrackingDetail!]`

Example

{"trackingDetails": [TrackingDetail]}

Types

AdminGetBoxBySerialNumberParams

Fields

Input Field	Description
`serialNumber` - `String!`

Example

{"serialNumber": "abc123"}

Types

AdminGetBoxBySerialNumberResponse

Fields

Field Name	Description
`box` - `Box!`
`customer` - `BoxCustomer`
`boxMedias` - `[BoxMedia]`
`trackingDetails` - `[TrackingDetail]`
`timelineEvents` - `[BoxHistory]`

Example

{
  "box": Box,
  "customer": BoxCustomer,
  "boxMedias": [BoxMedia],
  "trackingDetails": [TrackingDetail],
  "timelineEvents": [BoxHistory]
}

Types

AdminGetBoxesFilters

Fields

Input Field	Description
`search` - `String`
`state` - `[Int!]`
`status` - `[Int!]`
`customerId` - `[Int!]`
`warehouseId` - `[Int!]`
`storedAt` - `DateRange`
`billingReferenceDate` - `DateRange`
`labelsPrintedAt` - `DateRange`
`createdAt` - `DateRange`
`updatedAt` - `DateRange`

Example

{
  "search": "abc123",
  "state": [987],
  "status": [987],
  "customerId": [987],
  "warehouseId": [987],
  "storedAt": DateRange,
  "billingReferenceDate": DateRange,
  "labelsPrintedAt": DateRange,
  "createdAt": DateRange,
  "updatedAt": DateRange
}

Types

AdminGetBoxesParams

Fields

Input Field	Description
`filters` - `AdminGetBoxesFilters`
`sort` - `GetBoxesSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": AdminGetBoxesFilters,
  "sort": GetBoxesSort,
  "page": 123,
  "limit": 123
}

Types

AdminGetProductsFilters

Fields

Input Field	Description
`search` - `String`
`type` - `ProductType`
`status` - `[Int!]`
`statusesQuantityCheck` - `Boolean`
`isStarterKit` - `Boolean`

Example

{
  "search": "abc123",
  "type": "BOX",
  "status": [987],
  "statusesQuantityCheck": true,
  "isStarterKit": false
}

Types

AdminGetProductsParams

Fields

Input Field	Description
`filters` - `AdminGetProductsFilters`
`sort` - `AdminGetProductsSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": AdminGetProductsFilters,
  "sort": AdminGetProductsSort,
  "page": 123,
  "limit": 123
}

Types

AdminGetProductsSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "abc123",
  "direction": "xyz789"
}

Types

AdminUpdateBoxParams

Fields

Input Field	Description
`id` - `Int!`
`title` - `String`
`description` - `String`
`weight` - `Float`

Example

{
  "id": 987,
  "title": "xyz789",
  "description": "abc123",
  "weight": 987.65
}

Types

AdminUpdateBoxResponse

Fields

Field Name	Description
`box` - `Box!`

Example

{"box": Box}

Types

ApiKey

Fields

Field Name	Description
`id` - `Int`
`name` - `String`
`rawKey` - `String`
`key` - `String`
`roles` - `[String]`
`expiresAt` - `Date`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 123,
  "name": "xyz789",
  "rawKey": "abc123",
  "key": "abc123",
  "roles": ["abc123"],
  "expiresAt": "2007-12-03",
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

ArchiveWarehouseParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

AssignBoxToCustomerParams

Fields

Input Field	Description
`id` - `Int`	Target Box ID
`serialNumber` - `String!`	Inducted box serial number

Example

{"id": 123, "serialNumber": "abc123"}

Types

AssignBoxToCustomerResponse

Fields

Field Name	Description
`box` - `Box!`

Example

{"box": Box}

Types

AssignShoppingCartToCustomerByPhoneParams

Description

Params to assign a shopping cart to a customer by phone.

Fields

Input Field	Description
`externalId` - `String`
`cartId` - `Int`	(Deprecated) Use externalId instead of cartId
`phone` - `String!`	Phone number of the customer to assign the shopping cart to. Must be a valid phone number.

Example

{
  "externalId": "abc123",
  "cartId": 987,
  "phone": "xyz789"
}

Types

AuthenticateAdminUserParams

Fields

Input Field	Description
`credential` - `String!`

Example

{"credential": "abc123"}

Types

AuthenticateAdminUserValidateParams

Fields

Input Field	Description
`credential` - `String!`
`code` - `String!`

Example

{
  "credential": "xyz789",
  "code": "abc123"
}

Types

AuthenticateAdminUserValidateResponse

Fields

Field Name	Description
`token` - `String!`
`user` - `Admin!`

Example

{
  "token": "abc123",
  "user": Admin
}

Types

AuthenticateCustomerParams

Fields

Input Field	Description
`credential` - `String!`

Example

{"credential": "xyz789"}

Types

AuthenticateCustomerValidateParams

Fields

Input Field	Description
`credential` - `String!`
`code` - `String!`
`anonymousId` - `String`

Example

{
  "credential": "abc123",
  "code": "abc123",
  "anonymousId": "abc123"
}

Types

AuthenticateCustomerValidateResponse

Fields

Field Name	Description
`token` - `String!`
`refreshToken` - `String`
`user` - `Customer!`

Example

{
  "token": "xyz789",
  "refreshToken": "abc123",
  "user": Customer
}

Types

Barcode

Fields

Field Name	Description
`id` - `Int`
`code` - `String`
`barcodeBatchId` - `Int`
`boxTypeId` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`
`boxTypeName` - `String`
`customerName` - `String`

Example

{
  "id": 123,
  "code": "abc123",
  "barcodeBatchId": 123,
  "boxTypeId": 123,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "boxTypeName": "abc123",
  "customerName": "xyz789"
}

Types

BarcodeBatch

Fields

Field Name	Description
`id` - `Int`
`adminUserId` - `Int`
`warehouseId` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`
`barcodes` - `Int`

Example

{
  "id": 987,
  "adminUserId": 123,
  "warehouseId": 123,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "barcodes": 123
}

Types

BillingManagementTransaction

Fields

Field Name	Description
`id` - `Int`
`debitAmount` - `Float`
`creditAmount` - `Float`
`totalAmount` - `Float`
`type` - `Int`
`status` - `Int`
`paymentMethod` - `Int`
`paymentProviderTransactionId` - `String`
`account` - `String`
`description` - `String`
`notes` - `String`
`orderId` - `Int`
`orderType` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`
`customerName` - `String`
`skus` - `[String]`
`boxIds` - `[Int]`

Example

{
  "id": 987,
  "debitAmount": 123.45,
  "creditAmount": 987.65,
  "totalAmount": 123.45,
  "type": 987,
  "status": 123,
  "paymentMethod": 987,
  "paymentProviderTransactionId": "xyz789",
  "account": "xyz789",
  "description": "xyz789",
  "notes": "xyz789",
  "orderId": 987,
  "orderType": 987,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "customerName": "abc123",
  "skus": ["xyz789"],
  "boxIds": [123]
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

Box

Fields

Field Name	Description
`id` - `Int`
`title` - `String`
`description` - `String`
`state` - `Int`
`status` - `Int`
`weight` - `Float`
`storedAt` - `Date`
`billingReferenceDate` - `Date`
`activeReturnLabel` - `String`
`labelsPrintedAt` - `Date`
`labelsPrintedBy` - `String`
`thumbnail` - `String`
`packingAcknowledgedAt` - `Date`
`firstScannedAt` - `Date`
`barcodeId` - `Int`
`boxTypeId` - `Int`
`warehouseId` - `Int`
`warehouse` - `Warehouse`
`customerId` - `Int`
`warehouseSpotId` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`
`spotIdentifier` - `String`
`serialNumber` - `String`
`boxTypeName` - `String`
`boxTypeMaxWeight` - `Float`
`customerName` - `String`
`estimatedDeliveryDate` - `Date`
`medias` - `[BoxMedia]`
`returnLabels` - `[ReturnLabel]`
`boxType` - `BoxType`
`barcode` - `Barcode`
`trackingDetails` - `[TrackingDetail]`
`cancellationRequests` - `[CancellationRequest]`
`price` - `BoxPrice`

Example

{
  "id": 987,
  "title": "abc123",
  "description": "xyz789",
  "state": 987,
  "status": 123,
  "weight": 987.65,
  "storedAt": "2007-12-03",
  "billingReferenceDate": "2007-12-03",
  "activeReturnLabel": "abc123",
  "labelsPrintedAt": "2007-12-03",
  "labelsPrintedBy": "abc123",
  "thumbnail": "xyz789",
  "packingAcknowledgedAt": "2007-12-03",
  "firstScannedAt": "2007-12-03",
  "barcodeId": 123,
  "boxTypeId": 123,
  "warehouseId": 123,
  "warehouse": Warehouse,
  "customerId": 123,
  "warehouseSpotId": 123,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "spotIdentifier": "abc123",
  "serialNumber": "xyz789",
  "boxTypeName": "abc123",
  "boxTypeMaxWeight": 123.45,
  "customerName": "xyz789",
  "estimatedDeliveryDate": "2007-12-03",
  "medias": [BoxMedia],
  "returnLabels": [ReturnLabel],
  "boxType": BoxType,
  "barcode": Barcode,
  "trackingDetails": [TrackingDetail],
  "cancellationRequests": [CancellationRequest],
  "price": BoxPrice
}

Types

BoxActivity

Fields

Field Name	Description
`january` - `TrackingDetailStatistics`
`february` - `TrackingDetailStatistics`
`march` - `TrackingDetailStatistics`
`april` - `TrackingDetailStatistics`
`may` - `TrackingDetailStatistics`
`june` - `TrackingDetailStatistics`
`july` - `TrackingDetailStatistics`
`august` - `TrackingDetailStatistics`
`september` - `TrackingDetailStatistics`
`october` - `TrackingDetailStatistics`
`november` - `TrackingDetailStatistics`
`december` - `TrackingDetailStatistics`

Example

{
  "january": TrackingDetailStatistics,
  "february": TrackingDetailStatistics,
  "march": TrackingDetailStatistics,
  "april": TrackingDetailStatistics,
  "may": TrackingDetailStatistics,
  "june": TrackingDetailStatistics,
  "july": TrackingDetailStatistics,
  "august": TrackingDetailStatistics,
  "september": TrackingDetailStatistics,
  "october": TrackingDetailStatistics,
  "november": TrackingDetailStatistics,
  "december": TrackingDetailStatistics
}

Types

BoxCustomer

Fields

Field Name	Description
`id` - `Int`
`phone` - `String`
`email` - `String`
`firstName` - `String`
`lastName` - `String`
`status` - `Int`
`picture` - `String`
`recurrenceBaseInMonths` - `Int`	This field is being migrated to the Subscription model. It now reads from the active subscription's billing frequency. Please plan to migrate to subscription-based fields in future releases.
`lastRecurringPaymentDate` - `Date`	This field is being migrated to the Subscription model. It now reads from the active subscription's lastBillingDate. Please plan to migrate to subscription-based fields in future releases.

Example

{
  "id": 987,
  "phone": "abc123",
  "email": "abc123",
  "firstName": "abc123",
  "lastName": "abc123",
  "status": 123,
  "picture": "abc123",
  "recurrenceBaseInMonths": 123,
  "lastRecurringPaymentDate": "2007-12-03"
}

Types

BoxHistory

Fields

Field Name	Description
`id` - `Int`
`boxId` - `Int`
`fromStatus` - `Int`
`toStatus` - `Int`
`notes` - `String`
`createdAt` - `Date`
`updatedAt` - `Date`
`boxTitle` - `String`

Example

{
  "id": 123,
  "boxId": 123,
  "fromStatus": 123,
  "toStatus": 987,
  "notes": "abc123",
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "boxTitle": "abc123"
}

Types

BoxMedia

Fields

Field Name	Description
`id` - `Int`
`boxId` - `Int`
`url` - `String`
`fileName` - `String`
`fileType` - `String`
`private` - `Boolean`
`isDefault` - `Boolean`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 987,
  "boxId": 987,
  "url": "xyz789",
  "fileName": "abc123",
  "fileType": "xyz789",
  "private": false,
  "isDefault": true,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

BoxPrice

Fields

Field Name	Description
`id` - `Int`
`status` - `Int`
`boxId` - `Int`
`purchaseAmount` - `Int`
`recurrentAmount` - `Int`
`currency` - `Currency`
`minStoragePeriodAmount` - `Int`
`minStoragePeriodUnit` - `Int`
`includedStoragePeriodAmount` - `Int`
`includedStoragePeriodUnit` - `Int`
`originalRecurrentAmount` - `Int`
`previousRecurrentAmount` - `Int`
`recurrentAmountDiscountType` - `Int`
`previousRecurrentAmountDiscountType` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 123,
  "status": 123,
  "boxId": 123,
  "purchaseAmount": 123,
  "recurrentAmount": 987,
  "currency": "USD",
  "minStoragePeriodAmount": 123,
  "minStoragePeriodUnit": 123,
  "includedStoragePeriodAmount": 123,
  "includedStoragePeriodUnit": 123,
  "originalRecurrentAmount": 987,
  "previousRecurrentAmount": 987,
  "recurrentAmountDiscountType": 123,
  "previousRecurrentAmountDiscountType": 987,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

BoxStatistics

Fields

Field Name	Description
`active` - `Int`
`activity` - `BoxActivity`

Example

{"active": 123, "activity": BoxActivity}

Types

BoxThumbnail

Fields

Field Name	Description
`category` - `String`
`url` - `String`

Example

{
  "category": "abc123",
  "url": "abc123"
}

Types

BoxType

Fields

Field Name	Description
`id` - `Int`
`name` - `String`
`maxHeight` - `Float`
`maxWidth` - `Float`
`maxLength` - `Float`
`maxWeight` - `Float`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 123,
  "name": "xyz789",
  "maxHeight": 987.65,
  "maxWidth": 123.45,
  "maxLength": 123.45,
  "maxWeight": 987.65,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

BuyBoxesParams

Fields

Input Field	Description
`items` - `[CreateOrderItemParams!]!`
`shippingAddressId` - `Int!`
`creditCard` - `String`
`discountCouponId` - `Int`

Example

{
  "items": [CreateOrderItemParams],
  "shippingAddressId": 987,
  "creditCard": "abc123",
  "discountCouponId": 123
}

Types

BuyBoxesResponse

Fields

Field Name	Description
`order` - `Order!`

Example

{"order": Order}

Types

CanSignUpParams

Fields

Input Field	Description
`phone` - `String`
`email` - `String`

Example

{
  "phone": "abc123",
  "email": "abc123"
}

Types

CancelBoxesParams

Fields

Input Field	Description
`boxIds` - `[Int!]!`
`keepBoxes` - `Boolean!`
`reason` - `String`

Example

{
  "boxIds": [987],
  "keepBoxes": false,
  "reason": "xyz789"
}

Types

CancelDropOffParams

Fields

Input Field	Description
`id` - `Int!`
`boxId` - `Int!`

Example

{"id": 987, "boxId": 987}

Types

CancelMembershipParams

Fields

Input Field	Description
`intendsToKeepTheBoxes` - `Boolean!`
`feedback` - `String`

Example

{
  "intendsToKeepTheBoxes": true,
  "feedback": "xyz789"
}

Types

CancelOrderParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 987}

Types

CancelOrderResponse

Fields

Field Name	Description
`order` - `Order!`

Example

{"order": Order}

Types

CancelPickUpParams

Fields

Input Field	Description
`id` - `Int!`
`boxId` - `Int!`

Example

{"id": 123, "boxId": 987}

Types

CancellationRequest

Fields

Field Name	Description
`id` - `Int`
`boxId` - `Int`
`status` - `Int`
`requestedAt` - `Date`
`cancelledAt` - `Date`
`rejectedAt` - `Date`
`completedAt` - `Date`
`reason` - `String`
`notes` - `String`
`keepBox` - `Boolean`
`createdAt` - `Date`
`updatedAt` - `Date`
`box` - `Box`

Example

{
  "id": 987,
  "boxId": 987,
  "status": 987,
  "requestedAt": "2007-12-03",
  "cancelledAt": "2007-12-03",
  "rejectedAt": "2007-12-03",
  "completedAt": "2007-12-03",
  "reason": "xyz789",
  "notes": "xyz789",
  "keepBox": false,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "box": Box
}

Types

CheckDiscountCouponParams

Fields

Input Field	Description
`code` - `String!`

Example

{"code": "abc123"}

Types

CheckIfCustomerWouldPlaceAnInitialOrderParams

Fields

Input Field	Description
`phone` - `String!`

Example

{"phone": "xyz789"}

Types

CheckPickUpAvailabilityOption

Fields

Field Name	Description
`pickupDate` - `String`
`timeSlots` - `[CheckPickUpAvailabilityTimeSlot]`

Example

{
  "pickupDate": "abc123",
  "timeSlots": [CheckPickUpAvailabilityTimeSlot]
}

Types

CheckPickUpAvailabilityParams

Fields

Input Field	Description
`boxId` - `Int!`
`pickUpAddressId` - `Int!`
`dispatchDate` - `String`

Example

{
  "boxId": 987,
  "pickUpAddressId": 123,
  "dispatchDate": "xyz789"
}

Types

CheckPickUpAvailabilityResponse

Fields

Field Name	Description
`options` - `[CheckPickUpAvailabilityOption]`

Example

{"options": [CheckPickUpAvailabilityOption]}

Types

CheckPickUpAvailabilityTimeSlot

Fields

Field Name	Description
`readyTime` - `String`
`latestTime` - `String`

Example

{
  "readyTime": "xyz789",
  "latestTime": "xyz789"
}

Types

CompleteCancellationRequestParams

Fields

Input Field	Description
`id` - `Int!`
`notes` - `String`

Example

{"id": 123, "notes": "abc123"}

Types

CompleteCancellationRequestResponse

Fields

Field Name	Description
`cancellationRequest` - `CancellationRequest!`

Example

{"cancellationRequest": CancellationRequest}

Types

CompleteOrderParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

CompleteOrderResponse

Fields

Field Name	Description
`order` - `Order!`

Example

{"order": Order}

Types

ConfigurableParameter

Fields

Field Name	Description
`id` - `Int`
`key` - `String`
`value` - `String`
`type` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 987,
  "key": "abc123",
  "value": "xyz789",
  "type": 123,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

ConfirmSignUpParams

Fields

Input Field	Description
`credential` - `String!`
`code` - `String!`

Example

{
  "credential": "abc123",
  "code": "xyz789"
}

Types

ConfirmSignUpResponse

Fields

Field Name	Description
`token` - `String!`
`refreshToken` - `String`
`user` - `Customer!`

Example

{
  "token": "xyz789",
  "refreshToken": "xyz789",
  "user": Customer
}

Types

ConsentChannel

Values

Enum Value	Description
`IOS`
`ANDROID`
`WEB`
`EMAIL`

Example

"IOS"

Types

ConsentRecordInput

Fields

Input Field	Description
`consentType` - `ConsentType!`
`channel` - `ConsentChannel!`
`version` - `Int`

Example

{"consentType": "TERMS_OF_USE", "channel": "IOS", "version": 987}

Types

ConsentType

Values

Enum Value	Description
`TERMS_OF_USE`
`PRIVACY_POLICY`
`AUTO_RENEWAL`
`PREPAID_PAYMENT`

Example

"TERMS_OF_USE"

Types

CorrectedAddress

Fields

Field Name	Description
`street1` - `String`
`street2` - `String`
`city` - `String`
`state` - `String`
`zipcode` - `String`
`country` - `String`

Example

{
  "street1": "abc123",
  "street2": "xyz789",
  "city": "xyz789",
  "state": "abc123",
  "zipcode": "abc123",
  "country": "xyz789"
}

Types

CreateAdminUserParams

Fields

Input Field	Description
`firstName` - `String!`
`lastName` - `String!`
`email` - `String!`
`phone` - `String`	(Deprecated) Phone number is not used to create an admin user anymore
`roles` - `[String]!`
`warehouseId` - `Int`

Example

{
  "firstName": "abc123",
  "lastName": "abc123",
  "email": "abc123",
  "phone": "abc123",
  "roles": ["xyz789"],
  "warehouseId": 987
}

Types

CreateAdminUserResponse

Fields

Field Name	Description
`admin` - `Admin!`

Example

{"admin": Admin}

Types

CreateApiKeyParams

Fields

Input Field	Description
`name` - `String!`
`roles` - `[String!]!`
`expiresIn` - `String!`

Example

{
  "name": "abc123",
  "roles": ["abc123"],
  "expiresIn": "abc123"
}

Types

CreateApiKeyResponse

Fields

Field Name	Description
`apiKey` - `ApiKey!`

Example

{"apiKey": ApiKey}

Types

CreateBoxTypeParams

Fields

Input Field	Description
`name` - `String!`
`maxHeight` - `Float!`
`maxWidth` - `Float!`
`maxLength` - `Float!`
`maxWeight` - `Float!`

Example

{
  "name": "abc123",
  "maxHeight": 987.65,
  "maxWidth": 987.65,
  "maxLength": 123.45,
  "maxWeight": 123.45
}

Types

CreateBoxTypeResponse

Fields

Field Name	Description
`boxType` - `BoxType!`

Example

{"boxType": BoxType}

Types

CreateConfigurableParameterParams

Fields

Input Field	Description
`key` - `String!`
`value` - `String!`
`type` - `Int!`

Example

{
  "key": "xyz789",
  "value": "abc123",
  "type": 987
}

Types

CreateConfigurableParameterResponse

Fields

Field Name	Description
`configurableParameter` - `ConfigurableParameter!`

Example

{"configurableParameter": ConfigurableParameter}

Types

CreateCustomerAddressParams

Fields

Input Field	Description
`customerId` - `Int!`
`customerName` - `String!`
`title` - `String`
`street1` - `String!`
`street2` - `String`
`city` - `String!`
`state` - `String!`
`zipcode` - `String!`
`country` - `String!`
`residential` - `Boolean`
`defaultBilling` - `Boolean`
`defaultShipping` - `Boolean`
`instructions` - `String`
`latitude` - `Float`
`longitude` - `Float`

Example

{
  "customerId": 987,
  "customerName": "xyz789",
  "title": "abc123",
  "street1": "xyz789",
  "street2": "xyz789",
  "city": "abc123",
  "state": "xyz789",
  "zipcode": "abc123",
  "country": "xyz789",
  "residential": true,
  "defaultBilling": true,
  "defaultShipping": true,
  "instructions": "abc123",
  "latitude": 987.65,
  "longitude": 987.65
}

Types

CreateCustomerAddressResponse

Fields

Field Name	Description
`address` - `CustomerAddress!`
`correctedAddress` - `CorrectedAddress`

Example

{
  "address": CustomerAddress,
  "correctedAddress": CorrectedAddress
}

Types

CreateCustomerCreditCardParams

Fields

Input Field	Description
`holderName` - `String!`
`number` - `String!`
`expMonth` - `String!`
`expYear` - `String!`
`cvv` - `String!`

Example

{
  "holderName": "abc123",
  "number": "abc123",
  "expMonth": "abc123",
  "expYear": "xyz789",
  "cvv": "xyz789"
}

Types

CreateCustomerCreditCardResponse

Fields

Field Name	Description
`creditCard` - `CustomerCreditCard`

Example

{"creditCard": CustomerCreditCard}

Types

CreateCustomerGroupParams

Fields

Input Field	Description
`name` - `String!`
`description` - `String`
`status` - `CustomerGroupStatus!`
`paymentMethodRequired` - `Boolean!`
`purchaseFeeDiscountType` - `CustomerGroupDiscountType!`
`purchaseFeeDiscountAmount` - `Int!`
`storageFeeDiscountType` - `CustomerGroupDiscountType!`
`storageFeeDiscountAmount` - `Int!`
`excessWeightFeeDiscountType` - `CustomerGroupDiscountType!`
`excessWeightFeeDiscountAmount` - `Int!`
`returnToUserFeeDiscountType` - `CustomerGroupDiscountType!`
`returnToUserFeeDiscountAmount` - `Int!`

Example

{
  "name": "abc123",
  "description": "xyz789",
  "status": "INACTIVE",
  "paymentMethodRequired": false,
  "purchaseFeeDiscountType": "PERCENTAGE",
  "purchaseFeeDiscountAmount": 123,
  "storageFeeDiscountType": "PERCENTAGE",
  "storageFeeDiscountAmount": 123,
  "excessWeightFeeDiscountType": "PERCENTAGE",
  "excessWeightFeeDiscountAmount": 123,
  "returnToUserFeeDiscountType": "PERCENTAGE",
  "returnToUserFeeDiscountAmount": 987
}

Types

CreateCustomerGroupResponse

Fields

Field Name	Description
`customerGroup` - `CustomerGroup!`

Example

{"customerGroup": CustomerGroup}

Types

CreateCustomerParams

Fields

Input Field	Description
`firstName` - `String!`
`lastName` - `String!`
`email` - `String`
`phone` - `String!`
`status` - `Int!`

Example

{
  "firstName": "xyz789",
  "lastName": "abc123",
  "email": "abc123",
  "phone": "xyz789",
  "status": 987
}

Types

CreateCustomerPaymentMethodParams

Fields

Input Field	Description
`paymentMethodType` - `PaymentMethodType!`
`paymentMethodNonce` - `String!`

Example

{
  "paymentMethodType": "CREDIT_CARD",
  "paymentMethodNonce": "xyz789"
}

Types

CreateCustomerPaymentMethodResponse

Fields

Field Name	Description
`paymentMethod` - `CustomerCreditCard!`

Example

{"paymentMethod": CustomerCreditCard}

Types

CreateCustomerResponse

Fields

Field Name	Description
`customer` - `Customer!`

Example

{"customer": Customer}

Types

CreateDiscountCouponParams

Fields

Input Field	Description
`code` - `String!`
`type` - `DiscountCouponType!`
`amount` - `Float!`	Discount amount in cents or percentage value
`limit` - `Int`
`status` - `DiscountCouponStatus!`
`minimumPurchaseAmount` - `Int!`	Minimum purchase amount in cents
`maximumPurchaseAmount` - `Int`	Maximum purchase amount in cents
`startDate` - `String`
`endDate` - `String`
`isUnlimited` - `Boolean!`
`minimumBoxesAmount` - `Int`	Minimum boxes amount
`applyToRecurrentPayments` - `Boolean`	Apply to recurrent payments
`firstPurchaseOnly` - `Boolean`	Apply only to a customer first purchase
`usageLimitPerCustomer` - `Int`	Maximum number of times a customer can use this coupon
`recurringBillingCyclesLimit` - `Int!`	Number of billing cycles to apply recurring discount (includes initial purchase, 0 = unlimited)

Example

{
  "code": "xyz789",
  "type": "PERCENTAGE",
  "amount": 123.45,
  "limit": 123,
  "status": "ACTIVE",
  "minimumPurchaseAmount": 987,
  "maximumPurchaseAmount": 987,
  "startDate": "xyz789",
  "endDate": "abc123",
  "isUnlimited": false,
  "minimumBoxesAmount": 987,
  "applyToRecurrentPayments": true,
  "firstPurchaseOnly": false,
  "usageLimitPerCustomer": 987,
  "recurringBillingCyclesLimit": 987
}

Types

CreateDropOffAddressParams

Fields

Input Field	Description
`name` - `String!`
`street1` - `String!`
`street2` - `String`
`city` - `String!`
`state` - `String!`
`zipcode` - `String!`
`country` - `String!`
`residential` - `Boolean`

Example

{
  "name": "xyz789",
  "street1": "xyz789",
  "street2": "xyz789",
  "city": "abc123",
  "state": "xyz789",
  "zipcode": "abc123",
  "country": "xyz789",
  "residential": true
}

Types

CreateDropOffParams

Fields

Input Field	Description
`boxId` - `Int!`
`address` - `CreateDropOffAddressParams!`
`instructions` - `String`

Example

{
  "boxId": 123,
  "address": CreateDropOffAddressParams,
  "instructions": "xyz789"
}

Types

CreateDropOffResponse

Fields

Field Name	Description
`trackingDetail` - `TrackingDetail!`

Example

{"trackingDetail": TrackingDetail}

Types

CreateDropOffsParams

Fields

Input Field	Description
`boxIds` - `[Int!]!`
`address` - `CreateDropOffAddressParams!`
`instructions` - `String`

Example

{
  "boxIds": [123],
  "address": CreateDropOffAddressParams,
  "instructions": "xyz789"
}

Types

CreateDropOffsResponse

Fields

Field Name	Description
`trackingDetails` - `[TrackingDetail!]`

Example

{"trackingDetails": [TrackingDetail]}

Types

CreateNoteParams

Fields

Input Field	Description
`modelType` - `NoteModelType!`
`modelId` - `Int!`
`content` - `String!`

Example

{
  "modelType": "Box",
  "modelId": 123,
  "content": "abc123"
}

Types

CreateNoteResponse

Fields

Field Name	Description
`note` - `Note!`

Example

{"note": Note}

Types

CreateOrderFromCartAsCustomerParams

Fields

Input Field	Description
`externalId` - `String`
`cartId` - `Int`	(Deprecated) Use externalId instead of cartId
`creditCardId` - `String`
`paymentMethodNonce` - `String`
`consentRecords` - `[ConsentRecordInput]`

Example

{
  "externalId": "xyz789",
  "cartId": 123,
  "creditCardId": "abc123",
  "paymentMethodNonce": "abc123",
  "consentRecords": [ConsentRecordInput]
}

Types

CreateOrderFromCartAsGuestParams

Fields

Input Field	Description
`externalId` - `String!`
`customer` - `SignUpParams!`
`paymentMethodNonce` - `String!`
`paymentMethodType` - `PaymentMethodType!`

Example

{
  "externalId": "xyz789",
  "customer": SignUpParams,
  "paymentMethodNonce": "abc123",
  "paymentMethodType": "CREDIT_CARD"
}

Types

CreateOrderFromCartParams

Fields

Input Field	Description
`asGuestParams` - `CreateOrderFromCartAsGuestParams`
`asCustomerParams` - `CreateOrderFromCartAsCustomerParams`

Example

{
  "asGuestParams": CreateOrderFromCartAsGuestParams,
  "asCustomerParams": CreateOrderFromCartAsCustomerParams
}

Types

CreateOrderFromCartResponse

Fields

Field Name	Description
`order` - `Order!`

Example

{"order": Order}

Types

CreateOrderItemParams

Fields

Input Field	Description
`productId` - `Int!`
`qty` - `Int!`

Example

{"productId": 123, "qty": 123}

Types

CreatePickUpParams

Fields

Input Field	Description
`boxId` - `Int!`
`scheduledAt` - `String!`	ISO Date String - 2024-11-04T11:00:00.450Z
`customerCloseTime` - `String!`	Time String - 17:30:00
`pickUpAddressId` - `Int!`
`instructions` - `String`

Example

{
  "boxId": 987,
  "scheduledAt": "xyz789",
  "customerCloseTime": "xyz789",
  "pickUpAddressId": 123,
  "instructions": "abc123"
}

Types

CreatePickUpResponse

Fields

Field Name	Description
`trackingDetail` - `TrackingDetail!`

Example

{"trackingDetail": TrackingDetail}

Types

CreatePickUpsParams

Fields

Input Field	Description
`boxIds` - `[Int!]!`
`scheduledAt` - `String!`	ISO Date String - 2024-11-04T11:00:00.450Z
`customerCloseTime` - `String!`	Time String - 17:30:00
`pickUpAddressId` - `Int!`
`instructions` - `String`

Example

{
  "boxIds": [987],
  "scheduledAt": "xyz789",
  "customerCloseTime": "abc123",
  "pickUpAddressId": 987,
  "instructions": "xyz789"
}

Types

CreatePickUpsResponse

Fields

Field Name	Description
`trackingDetails` - `[TrackingDetail!]`

Example

{"trackingDetails": [TrackingDetail]}

Types

CreateProductParams

Fields

Input Field	Description
`sku` - `String!`
`status` - `Int`	(Deprecated) This field is deprecated and will be removed in future versions. New products will be created in DRAFT status
`title` - `String!`
`description` - `String!`
`shortDescription` - `String`
`urlKey` - `String`
`seoTitle` - `String`
`seoDescription` - `String`
`seoKeywords` - `String`
`boxTypeId` - `Int`
`quantity` - `Int`
`boxQuantity` - `Int`	This field will be set internally
`type` - `ProductType!`
`isMostPopular` - `Boolean`
`isStarterKit` - `Boolean`
`price` - `ProductPriceInput!`

Example

{
  "sku": "xyz789",
  "status": 123,
  "title": "abc123",
  "description": "abc123",
  "shortDescription": "abc123",
  "urlKey": "abc123",
  "seoTitle": "abc123",
  "seoDescription": "abc123",
  "seoKeywords": "abc123",
  "boxTypeId": 987,
  "quantity": 123,
  "boxQuantity": 123,
  "type": "BOX",
  "isMostPopular": false,
  "isStarterKit": false,
  "price": ProductPriceInput
}

Types

CreateProductResponse

Fields

Field Name	Description
`product` - `Product!`

Example

{"product": Product}

Types

CreateShoppingCartParams

Fields

Input Field	Description
`customerId` - `Int`
`anonymousId` - `String`
`items` - `[AddShoppingCartLineItemParams!]`
`discountCouponCode` - `String`

Example

{
  "customerId": 987,
  "anonymousId": "xyz789",
  "items": [AddShoppingCartLineItemParams],
  "discountCouponCode": "xyz789"
}

Types

CreateWarehouseParams

Fields

Input Field	Description
`name` - `String!`
`shipperName` - `String!`
`telephone` - `String!`
`street1` - `String!`
`street2` - `String`
`city` - `String!`
`state` - `String!`
`zipcode` - `String!`
`country` - `String!`

Example

{
  "name": "xyz789",
  "shipperName": "abc123",
  "telephone": "abc123",
  "street1": "xyz789",
  "street2": "xyz789",
  "city": "xyz789",
  "state": "xyz789",
  "zipcode": "abc123",
  "country": "xyz789"
}

Types

CreateWarehouseResponse

Fields

Field Name	Description
`warehouse` - `Warehouse!`

Example

{"warehouse": Warehouse}

Types

CreateWarehouseSpotParams

Fields

Input Field	Description
`warehouseId` - `Int!`
`spotIdentifier` - `String!`
`spotLocation` - `String`
`zone` - `String`
`location` - `String`
`notes` - `String`
`maxWeight` - `Float`
`maxWidth` - `Float`
`maxHeight` - `Float`
`maxLength` - `Float`
`type` - `Int!`

Example

{
  "warehouseId": 987,
  "spotIdentifier": "xyz789",
  "spotLocation": "xyz789",
  "zone": "xyz789",
  "location": "abc123",
  "notes": "xyz789",
  "maxWeight": 123.45,
  "maxWidth": 123.45,
  "maxHeight": 123.45,
  "maxLength": 123.45,
  "type": 123
}

Types

CreateWarehouseSpotResponse

Fields

Field Name	Description
`warehouseSpot` - `WarehouseSpot!`

Example

{"warehouseSpot": WarehouseSpot}

Types

CreateWarehouseSpotsParams

Fields

Input Field	Description
`warehouseId` - `Int!`
`quantities` - `CreateWarehouseSpotsQuantitiesParams!`

Example

{
  "warehouseId": 987,
  "quantities": CreateWarehouseSpotsQuantitiesParams
}

Types

CreateWarehouseSpotsQuantitiesParams

Fields

Input Field	Description
`aisles` - `Int!`
`rows` - `Int!`
`shelves` - `Int!`
`spots` - `Int!`

Example

{"aisles": 987, "rows": 123, "shelves": 123, "spots": 987}

Types

CreateWarehouseSpotsResponse

Fields

Field Name	Description
`first` - `String!`
`last` - `String!`
`count` - `Int!`
`codes` - `[String]!`

Example

{
  "first": "xyz789",
  "last": "abc123",
  "count": 123,
  "codes": ["xyz789"]
}

Types

Currency

Values

Enum Value	Description
`USD`

Example

"USD"

Types

Customer

Fields

Field Name	Description
`id` - `Int`
`phone` - `String`
`email` - `String`
`paymentProviderId` - `String`
`defaultPaymentId` - `String`
`firstName` - `String`
`lastName` - `String`
`status` - `Int`
`picture` - `String`
`pushNotificationsRelatedToBoxes` - `Boolean`
`emailNotificationsRelatedToBoxes` - `Boolean`
`smsNotificationsRelatedToBoxes` - `Boolean`
`inAppNotificationsRelatedToBoxes` - `Boolean`
`pushNotificationsRelatedToChat` - `Boolean`
`emailNotificationsRelatedToChat` - `Boolean`
`smsNotificationsRelatedToChat` - `Boolean`
`inAppNotificationsRelatedToChat` - `Boolean`
`pushNotificationsRelatedToProductAnnouncements` - `Boolean`
`emailNotificationsRelatedToProductAnnouncements` - `Boolean`
`smsNotificationsRelatedToProductAnnouncements` - `Boolean`
`inAppNotificationsRelatedToProductAnnouncements` - `Boolean`
`creditBalance` - `Float`
`recurrenceBaseInMonths` - `Int`	This field is being migrated to the Subscription model. It now reads from the active subscription's billing frequency. Please plan to migrate to subscription-based fields in future releases.
`lastRecurringPaymentDate` - `Date`	This field is being migrated to the Subscription model. It now reads from the active subscription's lastBillingDate. Please plan to migrate to subscription-based fields in future releases.
`cancellationRequestedAt` - `Date`	This field is being migrated to the Subscription model. It now reads from the active subscription's cancellationRequestedAt. Please plan to migrate to subscription-based fields in future releases.
`customerGroupId` - `Int`
`retrievalModelType` - `String`
`firstAppLoginAt` - `Date`
`createdAt` - `Date`
`updatedAt` - `Date`
`boxes` - `Int`
`activeBoxesCount` - `Int`
`addresses` - `[CustomerAddress]`
`creditCards` - `[CustomerCreditCard]`
`intercomHashes` - `IntercomHashes`
`customerGroup` - `CustomerGroup`
`subscription` - `Subscription`

Example

{
  "id": 123,
  "phone": "xyz789",
  "email": "xyz789",
  "paymentProviderId": "xyz789",
  "defaultPaymentId": "abc123",
  "firstName": "xyz789",
  "lastName": "xyz789",
  "status": 987,
  "picture": "xyz789",
  "pushNotificationsRelatedToBoxes": true,
  "emailNotificationsRelatedToBoxes": false,
  "smsNotificationsRelatedToBoxes": false,
  "inAppNotificationsRelatedToBoxes": false,
  "pushNotificationsRelatedToChat": false,
  "emailNotificationsRelatedToChat": false,
  "smsNotificationsRelatedToChat": false,
  "inAppNotificationsRelatedToChat": false,
  "pushNotificationsRelatedToProductAnnouncements": false,
  "emailNotificationsRelatedToProductAnnouncements": true,
  "smsNotificationsRelatedToProductAnnouncements": false,
  "inAppNotificationsRelatedToProductAnnouncements": true,
  "creditBalance": 987.65,
  "recurrenceBaseInMonths": 987,
  "lastRecurringPaymentDate": "2007-12-03",
  "cancellationRequestedAt": "2007-12-03",
  "customerGroupId": 123,
  "retrievalModelType": "xyz789",
  "firstAppLoginAt": "2007-12-03",
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "boxes": 123,
  "activeBoxesCount": 987,
  "addresses": [CustomerAddress],
  "creditCards": [CustomerCreditCard],
  "intercomHashes": IntercomHashes,
  "customerGroup": CustomerGroup,
  "subscription": Subscription
}

Types

CustomerAddress

Fields

Field Name	Description
`id` - `Int`
`customerName` - `String`
`title` - `String`
`street1` - `String`
`street2` - `String`
`city` - `String`
`state` - `String`
`zipcode` - `String`
`country` - `String`
`residential` - `Boolean`
`defaultBilling` - `Boolean`
`defaultShipping` - `Boolean`
`instructions` - `String`
`customerId` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 123,
  "customerName": "abc123",
  "title": "xyz789",
  "street1": "abc123",
  "street2": "xyz789",
  "city": "abc123",
  "state": "xyz789",
  "zipcode": "xyz789",
  "country": "abc123",
  "residential": true,
  "defaultBilling": true,
  "defaultShipping": true,
  "instructions": "abc123",
  "customerId": 987,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

CustomerCredit

Fields

Field Name	Description
`id` - `Int`
`customerId` - `Int`
`type` - `CustomerCreditType`
`status` - `CustomerCreditStatus`
`earnedDate` - `Date`
`usedDate` - `Date`
`expirationDate` - `Date`
`orderId` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 123,
  "customerId": 123,
  "type": "RETRIEVAL",
  "status": "ACTIVE",
  "earnedDate": "2007-12-03",
  "usedDate": "2007-12-03",
  "expirationDate": "2007-12-03",
  "orderId": 987,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

CustomerCreditCard

Fields

Field Name	Description
`id` - `String`
`last4` - `String`
`type` - `String`
`expMonth` - `String`
`expYear` - `String`
`holderName` - `String`
`paymentMethodType` - `String`

Example

{
  "id": "xyz789",
  "last4": "abc123",
  "type": "abc123",
  "expMonth": "abc123",
  "expYear": "abc123",
  "holderName": "abc123",
  "paymentMethodType": "xyz789"
}

Types

CustomerCreditStatus

Values

Enum Value	Description
`ACTIVE`
`USED`
`EXPIRED`

Example

"ACTIVE"

Types

CustomerCreditType

Values

Enum Value	Description
`RETRIEVAL`

Example

"RETRIEVAL"

Types

CustomerGroup

Fields

Field Name	Description
`id` - `Int`
`name` - `String`
`description` - `String`
`status` - `CustomerGroupStatus`
`paymentMethodRequired` - `Boolean`
`purchaseFeeDiscountType` - `CustomerGroupDiscountType`
`purchaseFeeDiscountAmount` - `Int`
`storageFeeDiscountType` - `CustomerGroupDiscountType`
`storageFeeDiscountAmount` - `Int`
`excessWeightFeeDiscountType` - `CustomerGroupDiscountType`
`excessWeightFeeDiscountAmount` - `Int`
`returnToUserFeeDiscountType` - `CustomerGroupDiscountType`
`returnToUserFeeDiscountAmount` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 987,
  "name": "xyz789",
  "description": "abc123",
  "status": "INACTIVE",
  "paymentMethodRequired": false,
  "purchaseFeeDiscountType": "PERCENTAGE",
  "purchaseFeeDiscountAmount": 123,
  "storageFeeDiscountType": "PERCENTAGE",
  "storageFeeDiscountAmount": 123,
  "excessWeightFeeDiscountType": "PERCENTAGE",
  "excessWeightFeeDiscountAmount": 987,
  "returnToUserFeeDiscountType": "PERCENTAGE",
  "returnToUserFeeDiscountAmount": 123,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

CustomerGroupDiscountType

Values

Enum Value	Description
`PERCENTAGE`
`FIXED`

Example

"PERCENTAGE"

Types

CustomerGroupStatus

Values

Enum Value	Description
`INACTIVE`
`ACTIVE`

Example

"INACTIVE"

Types

CustomerStatistics

Fields

Field Name	Description
`today` - `Int`
`yesterday` - `Int`
`week` - `Int`
`lastWeek` - `Int`
`month` - `Int`
`lastMonth` - `Int`

Example

{
  "today": 987,
  "yesterday": 123,
  "week": 123,
  "lastWeek": 123,
  "month": 987,
  "lastMonth": 987
}

Types

Date

Description

Scalar Date: YYYY-MM-DD

Example

"2007-12-03"

Types

DateRange

Fields

Input Field	Description
`from` - `Date`
`to` - `Date`

Example

{
  "from": "2007-12-03",
  "to": "2007-12-03"
}

Types

DeleteAdminUserParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

DeleteApiKeyParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 987}

Types

DeleteBoxMediaParams

Fields

Input Field	Description
`id` - `Int!`
`boxId` - `Int!`

Example

{"id": 123, "boxId": 123}

Types

DeleteBoxTypeParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 987}

Types

DeleteConfigurableParameterParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

DeleteCustomerAddressParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 987}

Types

DeleteCustomerCreditCardParams

Fields

Input Field	Description
`id` - `String!`

Example

{"id": "abc123"}

Types

DeleteCustomerPictureParams

Fields

Input Field	Description
`customerId` - `Int!`

Example

{"customerId": 987}

Types

DeleteNoteParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

DeleteProductImagesParams

Fields

Input Field	Description
`ids` - `[Int!]!`

Example

{"ids": [987]}

Types

DeleteProductParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

DeleteWarehouseSpotParams

Fields

Input Field	Description
`id` - `Int!`
`warehouseId` - `Int!`

Example

{"id": 987, "warehouseId": 123}

Types

DiscountCouponResult

Fields

Field Name	Description
`id` - `Int!`
`code` - `String!`
`type` - `String!`
`amount` - `Float!`
`limit` - `Int`
`usage` - `Int!`
`startDate` - `Date`
`endDate` - `Date`
`createdAt` - `Date!`
`updatedAt` - `Date!`
`status` - `String!`
`minimumPurchaseAmount` - `Int!`	Minimum purchase amount in cents
`maximumPurchaseAmount` - `Int`	Maximum purchase amount in cents
`isUnlimited` - `Boolean!`
`minimumBoxesAmount` - `Int`	Minimum boxes amount
`applyToRecurrentPayments` - `Boolean`	Apply to recurrent payments
`firstPurchaseOnly` - `Boolean`	Apply only to a customer first purchase
`usageLimitPerCustomer` - `Int`	Maximum number of times a customer can use this coupon
`recurringBillingCyclesLimit` - `Int!`	Number of billing cycles to apply recurring discount (includes initial purchase, 0 = unlimited)

Example

{
  "id": 123,
  "code": "abc123",
  "type": "xyz789",
  "amount": 123.45,
  "limit": 123,
  "usage": 123,
  "startDate": "2007-12-03",
  "endDate": "2007-12-03",
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "status": "xyz789",
  "minimumPurchaseAmount": 987,
  "maximumPurchaseAmount": 987,
  "isUnlimited": true,
  "minimumBoxesAmount": 123,
  "applyToRecurrentPayments": true,
  "firstPurchaseOnly": true,
  "usageLimitPerCustomer": 123,
  "recurringBillingCyclesLimit": 123
}

Types

DiscountCouponStatus

Values

Enum Value	Description
`ACTIVE`
`INACTIVE`

Example

"ACTIVE"

Types

DiscountCouponType

Values

Enum Value	Description
`PERCENTAGE`
`FIXED`

Example

"PERCENTAGE"

Types

DiscountCouponsResult

Fields

Field Name	Description
`total` - `Int!`
`discountCoupons` - `[DiscountCouponResult]!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "total": 123,
  "discountCoupons": [DiscountCouponResult],
  "page": 987,
  "limit": 123
}

Types

DropOffLocation

Fields

Field Name	Description
`distance` - `DropOffLocationDistance`
`contact` - `DropOffLocationContact`
`address` - `DropOffLocationAddress`
`geoPositionalCoordinates` - `DropOffLocationGeoPositionalCoordinates`
`packageMaximumLimits` - `DropOffLocationPackageMaximumLimits`

Example

{
  "distance": DropOffLocationDistance,
  "contact": DropOffLocationContact,
  "address": DropOffLocationAddress,
  "geoPositionalCoordinates": DropOffLocationGeoPositionalCoordinates,
  "packageMaximumLimits": DropOffLocationPackageMaximumLimits
}

Types

DropOffLocationAddress

Fields

Field Name	Description
`street1` - `String`
`street2` - `String`
`city` - `String`
`state` - `String`
`zipcode` - `String`
`country` - `String`
`residential` - `Boolean`

Example

{
  "street1": "xyz789",
  "street2": "abc123",
  "city": "xyz789",
  "state": "abc123",
  "zipcode": "abc123",
  "country": "abc123",
  "residential": false
}

Types

DropOffLocationContact

Fields

Field Name	Description
`companyName` - `String`
`phoneNumber` - `String`
`displayName` - `String`

Example

{
  "companyName": "xyz789",
  "phoneNumber": "abc123",
  "displayName": "abc123"
}

Types

DropOffLocationDistance

Fields

Field Name	Description
`units` - `String`
`value` - `Float`

Example

{"units": "xyz789", "value": 987.65}

Types

DropOffLocationGeoPositionalCoordinates

Fields

Field Name	Description
`latitude` - `Float`
`longitude` - `Float`

Example

{"latitude": 987.65, "longitude": 987.65}

Types

DropOffLocationPackageMaximumLimits

Fields

Field Name	Description
`weight` - `DropOffLocationPackageMaximumLimitsWeight`
`dimensions` - `DropOffLocationPackageMaximumLimitsDimensions`

Example

{
  "weight": DropOffLocationPackageMaximumLimitsWeight,
  "dimensions": DropOffLocationPackageMaximumLimitsDimensions
}

Types

DropOffLocationPackageMaximumLimitsDimensions

Fields

Field Name	Description
`units` - `String`
`length` - `Float`
`width` - `Float`
`height` - `Float`

Example

{
  "units": "xyz789",
  "length": 123.45,
  "width": 123.45,
  "height": 123.45
}

Types

DropOffLocationPackageMaximumLimitsWeight

Fields

Field Name	Description
`units` - `String`
`value` - `Float`

Example

{"units": "xyz789", "value": 987.65}

Types

ExcludeCustomerFromCustomerGroupParams

Fields

Input Field	Description
`customerId` - `Int!`
`customerGroupId` - `Int!`

Example

{"customerId": 123, "customerGroupId": 987}

Types

ExtendedTrackingDetail

Fields

Field Name	Description
`id` - `Int`
`boxId` - `Int`
`trackingNumber` - `String`
`type` - `Int`
`status` - `Int`
`shippedAt` - `Date`
`estimatedDeliveryDate` - `Date`
`deliveredAt` - `Date`
`scheduledAt` - `Date`
`customerCloseTime` - `String`
`notes` - `String`
`instructions` - `String`
`confirmationCode` - `String`
`createdAt` - `Date`
`updatedAt` - `Date`
`addresses` - `[TrackingDetailAddress]`
`customer` - `ExtendedTrackingDetailCustomer`
`boxSerialNumber` - `String`
`warehouseId` - `Int`
`warehouse` - `Warehouse`
`scheduledAtInUtc` - `Date`
`customerCloseTimeInUtc` - `Date`

Example

{
  "id": 123,
  "boxId": 987,
  "trackingNumber": "abc123",
  "type": 123,
  "status": 987,
  "shippedAt": "2007-12-03",
  "estimatedDeliveryDate": "2007-12-03",
  "deliveredAt": "2007-12-03",
  "scheduledAt": "2007-12-03",
  "customerCloseTime": "abc123",
  "notes": "xyz789",
  "instructions": "xyz789",
  "confirmationCode": "xyz789",
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "addresses": [TrackingDetailAddress],
  "customer": ExtendedTrackingDetailCustomer,
  "boxSerialNumber": "abc123",
  "warehouseId": 123,
  "warehouse": Warehouse,
  "scheduledAtInUtc": "2007-12-03",
  "customerCloseTimeInUtc": "2007-12-03"
}

Types

ExtendedTrackingDetailCustomer

Fields

Field Name	Description
`id` - `Int`
`firstName` - `String`
`lastName` - `String`

Example

{
  "id": 123,
  "firstName": "abc123",
  "lastName": "xyz789"
}

Types

Float

Description

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

Example

987.65

Types

GenerateOrderReturnLabelsParams

Fields

Input Field	Description
`orderId` - `Int!`
`replaceExistingLabels` - `Boolean`

Example

{"orderId": 123, "replaceExistingLabels": false}

Types

GenerateOrderShippingLabelsParams

Fields

Input Field	Description
`orderId` - `Int!`
`serviceType` - `ServiceTypes`
`replaceExistingLabels` - `Boolean`

Example

{"orderId": 123, "serviceType": "GROUND", "replaceExistingLabels": true}

Types

GeneratePayPalClientTokenResponse

Fields

Field Name	Description
`clientToken` - `String!`

Example

{"clientToken": "abc123"}

Types

GenerateReturnLabelsParams

Fields

Input Field	Description
`qty` - `Int!`
`warehouseId` - `Int!`

Example

{"qty": 987, "warehouseId": 987}

Types

GenerateSerialNumbersParams

Fields

Input Field	Description
`qty` - `Int!`
`boxTypeId` - `Int!`
`warehouseId` - `Int!`

Example

{"qty": 123, "boxTypeId": 987, "warehouseId": 123}

Types

GetActiveShoppingCartParams

Fields

Input Field	Description
`customerId` - `Int`
`anonymousId` - `String`

Example

{"customerId": 123, "anonymousId": "xyz789"}

Types

GetAdminUserParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

GetAdminUserResponse

Fields

Field Name	Description
`admin` - `Admin!`

Example

{"admin": Admin}

Types

GetAdminUsersFilters

Fields

Input Field	Description
`search` - `String`
`roles` - `[String]`

Example

{
  "search": "abc123",
  "roles": ["xyz789"]
}

Types

GetAdminUsersParams

Fields

Input Field	Description
`filters` - `GetAdminUsersFilters`
`sort` - `GetAdminUsersSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetAdminUsersFilters,
  "sort": GetAdminUsersSort,
  "page": 987,
  "limit": 987
}

Types

GetAdminUsersResponse

Fields

Field Name	Description
`admins` - `[Admin]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "admins": [Admin],
  "total": 123,
  "page": 123,
  "limit": 987
}

Types

GetAdminUsersSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "xyz789",
  "direction": "xyz789"
}

Types

GetAllTrackingDetailsFilters

Fields

Input Field	Description
`search` - `String`
`type` - `[String!]`	types: "DROP_OFF" \| "PICK_UP" \| "RETURN_TO_USER
`status` - `[String!]`	status: "READY" \| "IN_PROGRESS" \| "COMPLETED" \| "CANCELLED
`customerId` - `[Int!]`
`warehouseId` - `[Int!]`
`shippedAt` - `DateRange`
`estimatedDeliveryDate` - `DateRange`
`deliveredAt` - `DateRange`
`scheduledAt` - `DateRange`
`createdAt` - `DateRange`
`updatedAt` - `DateRange`

Example

{
  "search": "xyz789",
  "type": ["abc123"],
  "status": ["xyz789"],
  "customerId": [123],
  "warehouseId": [987],
  "shippedAt": DateRange,
  "estimatedDeliveryDate": DateRange,
  "deliveredAt": DateRange,
  "scheduledAt": DateRange,
  "createdAt": DateRange,
  "updatedAt": DateRange
}

Types

GetAllTrackingDetailsParams

Fields

Input Field	Description
`filters` - `GetAllTrackingDetailsFilters`
`sort` - `GetAllTrackingDetailsSort`	sort: "createdAt" \| "updatedAt
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetAllTrackingDetailsFilters,
  "sort": GetAllTrackingDetailsSort,
  "page": 123,
  "limit": 123
}

Types

GetAllTrackingDetailsResponse

Fields

Field Name	Description
`trackingDetails` - `[ExtendedTrackingDetail]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "trackingDetails": [ExtendedTrackingDetail],
  "total": 987,
  "page": 987,
  "limit": 987
}

Types

GetAllTrackingDetailsSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "abc123",
  "direction": "xyz789"
}

Types

GetApiKeyParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

GetApiKeyResponse

Fields

Field Name	Description
`apiKey` - `ApiKey!`

Example

{"apiKey": ApiKey}

Types

GetApiKeysParams

Fields

Input Field	Description
`page` - `Int`
`limit` - `Int`

Example

{"page": 987, "limit": 987}

Types

GetApiKeysResponse

Fields

Field Name	Description
`apiKeys` - `[ApiKey]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "apiKeys": [ApiKey],
  "total": 987,
  "page": 987,
  "limit": 987
}

Types

GetBarcodeBatchParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

GetBarcodeBatchResponse

Fields

Field Name	Description
`barcodeBatch` - `BarcodeBatch!`

Example

{"barcodeBatch": BarcodeBatch}

Types

GetBarcodeBatchesParams

Fields

Input Field	Description
`page` - `Int`
`limit` - `Int`

Example

{"page": 123, "limit": 987}

Types

GetBarcodeBatchesResponse

Fields

Field Name	Description
`barcodeBatches` - `[BarcodeBatch]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "barcodeBatches": [BarcodeBatch],
  "total": 987,
  "page": 123,
  "limit": 123
}

Types

GetBarcodeParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

GetBarcodeResponse

Fields

Field Name	Description
`barcode` - `Barcode!`

Example

{"barcode": Barcode}

Types

GetBarcodesFilters

Fields

Input Field	Description
`barcodeBatchId` - `Int`
`boxTypeId` - `Int`
`search` - `String`

Example

{
  "barcodeBatchId": 123,
  "boxTypeId": 987,
  "search": "abc123"
}

Types

GetBarcodesParams

Fields

Input Field	Description
`filters` - `GetBarcodesFilters`
`sort` - `GetBarcodesSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetBarcodesFilters,
  "sort": GetBarcodesSort,
  "page": 123,
  "limit": 987
}

Types

GetBarcodesResponse

Fields

Field Name	Description
`barcodes` - `[Barcode]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "barcodes": [Barcode],
  "total": 123,
  "page": 987,
  "limit": 123
}

Types

GetBarcodesSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "xyz789",
  "direction": "abc123"
}

Types

GetBoxBySerialNumberParams

Fields

Input Field	Description
`serialNumber` - `String!`

Example

{"serialNumber": "abc123"}

Types

GetBoxBySerialNumberResponse

Fields

Field Name	Description
`box` - `Box!`

Example

{"box": Box}

Types

GetBoxMediasFilters

Fields

Input Field	Description
`boxId` - `Int!`
`fileType` - `String`

Example

{"boxId": 123, "fileType": "xyz789"}

Types

GetBoxMediasParams

Fields

Input Field	Description
`filters` - `GetBoxMediasFilters!`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetBoxMediasFilters,
  "page": 123,
  "limit": 987
}

Types

GetBoxMediasResponse

Fields

Field Name	Description
`boxMedias` - `[BoxMedia]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "boxMedias": [BoxMedia],
  "total": 987,
  "page": 987,
  "limit": 123
}

Types

GetBoxParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

GetBoxResponse

Fields

Field Name	Description
`box` - `Box!`

Example

{"box": Box}

Types

GetBoxThumbnailsResponse

Fields

Field Name	Description
`boxThumbnails` - `[BoxThumbnail]!`

Example

{"boxThumbnails": [BoxThumbnail]}

Types

GetBoxTypeParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 987}

Types

GetBoxTypeResponse

Fields

Field Name	Description
`boxType` - `BoxType!`

Example

{"boxType": BoxType}

Types

GetBoxTypesFilters

Fields

Input Field	Description
`search` - `String`

Example

{"search": "abc123"}

Types

GetBoxTypesParams

Fields

Input Field	Description
`filters` - `GetBoxTypesFilters`
`sort` - `GetBoxTypesSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetBoxTypesFilters,
  "sort": GetBoxTypesSort,
  "page": 987,
  "limit": 987
}

Types

GetBoxTypesResponse

Fields

Field Name	Description
`boxTypes` - `[BoxType]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "boxTypes": [BoxType],
  "total": 987,
  "page": 123,
  "limit": 987
}

Types

GetBoxTypesSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "abc123",
  "direction": "abc123"
}

Types

GetBoxesFilters

Fields

Input Field	Description
`search` - `String`
`state` - `[Int!]`
`status` - `[Int!]`
`customerId` - `Int`
`warehouseId` - `Int`

Example

{
  "search": "xyz789",
  "state": [123],
  "status": [987],
  "customerId": 123,
  "warehouseId": 123
}

Types

GetBoxesParams

Fields

Input Field	Description
`filters` - `GetBoxesFilters`
`sort` - `GetBoxesSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetBoxesFilters,
  "sort": GetBoxesSort,
  "page": 987,
  "limit": 123
}

Types

GetBoxesResponse

Fields

Field Name	Description
`boxes` - `[Box]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{"boxes": [Box], "total": 123, "page": 987, "limit": 123}

Types

GetBoxesSimplifiedInformationBySerialNumbersParams

Fields

Input Field	Description
`serialNumbers` - `[String!]!`
`page` - `Int`
`limit` - `Int`

Example

{
  "serialNumbers": ["xyz789"],
  "page": 987,
  "limit": 123
}

Types

GetBoxesSimplifiedInformationBySerialNumbersResponse

Fields

Field Name	Description
`boxes` - `[SimplifiedBoxInformation]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "boxes": [SimplifiedBoxInformation],
  "total": 123,
  "page": 987,
  "limit": 987
}

Types

GetBoxesSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "abc123",
  "direction": "xyz789"
}

Types

GetCancellationRequestParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

GetCancellationRequestResponse

Fields

Field Name	Description
`cancellationRequest` - `CancellationRequest!`

Example

{"cancellationRequest": CancellationRequest}

Types

GetCancellationRequestsFilters

Fields

Input Field	Description
`search` - `String`
`status` - `[Int!]`
`boxId` - `[Int!]`
`requestedAt` - `DateRange`
`cancelledAt` - `DateRange`
`rejectedAt` - `DateRange`
`completedAt` - `DateRange`
`createdAt` - `DateRange`
`updatedAt` - `DateRange`

Example

{
  "search": "abc123",
  "status": [123],
  "boxId": [987],
  "requestedAt": DateRange,
  "cancelledAt": DateRange,
  "rejectedAt": DateRange,
  "completedAt": DateRange,
  "createdAt": DateRange,
  "updatedAt": DateRange
}

Types

GetCancellationRequestsParams

Fields

Input Field	Description
`filters` - `GetCancellationRequestsFilters`
`sort` - `GetCancellationRequestsSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetCancellationRequestsFilters,
  "sort": GetCancellationRequestsSort,
  "page": 123,
  "limit": 987
}

Types

GetCancellationRequestsResponse

Fields

Field Name	Description
`cancellationRequests` - `[CancellationRequest]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "cancellationRequests": [CancellationRequest],
  "total": 987,
  "page": 987,
  "limit": 987
}

Types

GetCancellationRequestsSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "abc123",
  "direction": "xyz789"
}

Types

GetConfigurableParameterParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

GetConfigurableParameterResponse

Fields

Field Name	Description
`configurableParameter` - `ConfigurableParameter!`

Example

{"configurableParameter": ConfigurableParameter}

Types

GetConfigurableParametersFilters

Fields

Input Field	Description
`search` - `String`

Example

{"search": "xyz789"}

Types

GetConfigurableParametersParams

Fields

Input Field	Description
`filters` - `GetConfigurableParametersFilters`
`sort` - `GetConfigurableParametersSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetConfigurableParametersFilters,
  "sort": GetConfigurableParametersSort,
  "page": 987,
  "limit": 123
}

Types

GetConfigurableParametersResponse

Fields

Field Name	Description
`configurableParameters` - `[ConfigurableParameter]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "configurableParameters": [ConfigurableParameter],
  "total": 987,
  "page": 123,
  "limit": 987
}

Types

GetConfigurableParametersSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "xyz789",
  "direction": "abc123"
}

Types

GetCostToRetrieveBoxesItem

Fields

Field Name	Description
`key` - `String!`
`description` - `String!`
`quantity` - `Int!`
`unityCost` - `Float!`

Example

{
  "key": "xyz789",
  "description": "xyz789",
  "quantity": 123,
  "unityCost": 123.45
}

Types

GetCostToRetrieveBoxesParams

Fields

Input Field	Description
`boxIds` - `[Int!]!`
`directSignatureRequired` - `Boolean!`

Example

{"boxIds": [123], "directSignatureRequired": false}

Types

GetCostToRetrieveBoxesResponse

Fields

Field Name	Description
`items` - `[GetCostToRetrieveBoxesItem!]!`
`subtotalAmount` - `Float!`
`discountAmount` - `Float!`
`totalAmount` - `Float!`

Example

{
  "items": [GetCostToRetrieveBoxesItem],
  "subtotalAmount": 123.45,
  "discountAmount": 987.65,
  "totalAmount": 987.65
}

Types

GetCustomerCreditsFilters

Fields

Input Field	Description
`customerId` - `Int!`
`type` - `[CustomerCreditType!]`
`status` - `[CustomerCreditStatus!]`

Example

{"customerId": 987, "type": ["RETRIEVAL"], "status": ["ACTIVE"]}

Types

GetCustomerCreditsParams

Fields

Input Field	Description
`filters` - `GetCustomerCreditsFilters`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetCustomerCreditsFilters,
  "page": 123,
  "limit": 123
}

Types

GetCustomerCreditsResponse

Fields

Field Name	Description
`customerCredits` - `[CustomerCredit]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "customerCredits": [CustomerCredit],
  "total": 123,
  "page": 123,
  "limit": 987
}

Types

GetCustomerGroupParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 987}

Types

GetCustomerGroupResponse

Fields

Field Name	Description
`customerGroup` - `CustomerGroup!`

Example

{"customerGroup": CustomerGroup}

Types

GetCustomerGroupsFilters

Fields

Input Field	Description
`search` - `String`
`status` - `CustomerGroupStatus`

Example

{"search": "abc123", "status": "INACTIVE"}

Types

GetCustomerGroupsParams

Fields

Input Field	Description
`filters` - `GetCustomerGroupsFilters`
`sort` - `GetCustomerGroupsSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetCustomerGroupsFilters,
  "sort": GetCustomerGroupsSort,
  "page": 123,
  "limit": 987
}

Types

GetCustomerGroupsResponse

Fields

Field Name	Description
`customerGroups` - `[CustomerGroup]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "customerGroups": [CustomerGroup],
  "total": 123,
  "page": 123,
  "limit": 123
}

Types

GetCustomerGroupsSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "abc123",
  "direction": "xyz789"
}

Types

GetCustomerParams

Fields

Input Field	Description
`id` - `Int`

Example

{"id": 123}

Types

GetCustomerResponse

Fields

Field Name	Description
`customer` - `Customer!`

Example

{"customer": Customer}

Types

GetCustomersFilters

Fields

Input Field	Description
`search` - `String`
`status` - `Int`
`customerGroupId` - `Int`
`cancellationRequestedAt` - `DateRange`
`cancellationRequestedOnly` - `Boolean`
`membershipStatus` - `MembershipStatus`

Example

{
  "search": "xyz789",
  "status": 987,
  "customerGroupId": 123,
  "cancellationRequestedAt": DateRange,
  "cancellationRequestedOnly": true,
  "membershipStatus": "ACTIVE"
}

Types

GetCustomersParams

Fields

Input Field	Description
`filters` - `GetCustomersFilters`
`sort` - `GetCustomersSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetCustomersFilters,
  "sort": GetCustomersSort,
  "page": 987,
  "limit": 987
}

Types

GetCustomersResponse

Fields

Field Name	Description
`customers` - `[Customer]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "customers": [Customer],
  "total": 123,
  "page": 123,
  "limit": 987
}

Types

GetCustomersSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "abc123",
  "direction": "abc123"
}

Types

GetDiscountCouponParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

GetDiscountCouponsFilters

Fields

Input Field	Description
`search` - `String`
`status` - `DiscountCouponStatus`

Example

{"search": "xyz789", "status": "ACTIVE"}

Types

GetDiscountCouponsParams

Fields

Input Field	Description
`filters` - `GetDiscountCouponsFilters`
`sort` - `GetDiscountCouponsSort`
`page` - `Int`
`limit` - `Int`
`offset` - `Int`

Example

{
  "filters": GetDiscountCouponsFilters,
  "sort": GetDiscountCouponsSort,
  "page": 123,
  "limit": 987,
  "offset": 123
}

Types

GetDiscountCouponsSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "xyz789",
  "direction": "abc123"
}

Types

GetDropOffLocationsParams

Fields

Input Field	Description
`addressId` - `Int!`
`zipcodeToOverwrite` - `String`

Example

{
  "addressId": 987,
  "zipcodeToOverwrite": "abc123"
}

Types

GetDropOffLocationsResponse

Fields

Field Name	Description
`dropOffLocations` - `[DropOffLocation]!`

Example

{"dropOffLocations": [DropOffLocation]}

Types

GetMembershipDetailsParams

Fields

Input Field	Description
`boxIdsToCalculateNewMembershipCost` - `[Int]`

Example

{"boxIdsToCalculateNewMembershipCost": [987]}

Types

GetMembershipDetailsResponse

Fields

Field Name	Description
`memberSince` - `Date`
`membershipCost` - `Float`
`newMembershipCost` - `Float`
`recurringBillingInMonths` - `Int`
`firstPaymentDate` - `Date`
`lastPaymentDate` - `Date`
`nextPaymentDate` - `Date`

Example

{
  "memberSince": "2007-12-03",
  "membershipCost": 123.45,
  "newMembershipCost": 123.45,
  "recurringBillingInMonths": 123,
  "firstPaymentDate": "2007-12-03",
  "lastPaymentDate": "2007-12-03",
  "nextPaymentDate": "2007-12-03"
}

Types

GetMinimumTransitTimeInDaysToRetrieveBoxesParams

Fields

Input Field	Description
`boxIds` - `[Int!]!`
`shippingAddressId` - `Int!`

Example

{"boxIds": [987], "shippingAddressId": 123}

Types

GetMinimumTransitTimeInDaysToRetrieveBoxesResponse

Fields

Field Name	Description
`minimumTransitTimeInDays` - `Int!`	The value will be mocked to 1. See reference in FLYBOX-1523
`nextValidDeliveryDate` - `String!`	This will actually represent the next available shipping date. See reference in FLYBOX-1523

Example

{
  "minimumTransitTimeInDays": 123,
  "nextValidDeliveryDate": "xyz789"
}

Types

GetMonthlyStorageErrorParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 987}

Types

GetMonthlyStorageErrorResponse

Fields

Field Name	Description
`monthlyStorageError` - `MonthlyStorageError`

Example

{"monthlyStorageError": MonthlyStorageError}

Types

GetMonthlyStorageErrorsFilters

Fields

Input Field	Description
`search` - `String`
`customerIds` - `[Int!]`
`createdAt` - `DateRange`
`updatedAt` - `DateRange`

Example

{
  "search": "xyz789",
  "customerIds": [123],
  "createdAt": DateRange,
  "updatedAt": DateRange
}

Types

GetMonthlyStorageErrorsParams

Fields

Input Field	Description
`page` - `Int`
`limit` - `Int`
`filters` - `GetMonthlyStorageErrorsFilters`
`sort` - `GetMonthlyStorageErrorsSort`

Example

{
  "page": 987,
  "limit": 123,
  "filters": GetMonthlyStorageErrorsFilters,
  "sort": GetMonthlyStorageErrorsSort
}

Types

GetMonthlyStorageErrorsResponse

Fields

Field Name	Description
`monthlyStorageErrors` - `[MonthlyStorageError]`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "monthlyStorageErrors": [MonthlyStorageError],
  "total": 987,
  "page": 987,
  "limit": 123
}

Types

GetMonthlyStorageErrorsSort

Fields

Input Field	Description
`field` - `String!`	id \| customerId \| message \| createdAt \| updatedAt
`direction` - `SortDirection!`

Example

{"field": "xyz789", "direction": "ASC"}

Types

GetNotesParams

Fields

Input Field	Description
`modelType` - `NoteModelType!`
`modelId` - `Int!`

Example

{"modelType": "Box", "modelId": 987}

Types

GetNotesResponse

Fields

Field Name	Description
`notes` - `[Note]!`

Example

{"notes": [Note]}

Types

GetOrderParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 987}

Types

GetOrderResponse

Fields

Field Name	Description
`order` - `Order!`

Example

{"order": Order}

Types

GetOrderShippingAddressNearestWarehouseParams

Fields

Input Field	Description
`orderId` - `Int!`

Example

{"orderId": 987}

Types

GetOrderShippingAddressNearestWarehouseResponse

Fields

Field Name	Description
`warehouse` - `Warehouse`

Example

{"warehouse": Warehouse}

Types

GetOrdersFilters

Fields

Input Field	Description
`search` - `String`
`status` - `Int`	Filter by a single order status (deprecated, use statuses instead)
`statuses` - `[Int]`	Filter by multiple order statuses
`type` - `Int`	Filter by a single order type (deprecated, use types instead)
`types` - `[Int]`	Filter by multiple order types
`customerId` - `Int`
`createdAt` - `DateRange`
`updatedAt` - `DateRange`

Example

{
  "search": "abc123",
  "status": 987,
  "statuses": [987],
  "type": 987,
  "types": [987],
  "customerId": 987,
  "createdAt": DateRange,
  "updatedAt": DateRange
}

Types

GetOrdersParams

Fields

Input Field	Description
`filters` - `GetOrdersFilters`
`sort` - `GetOrdersSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetOrdersFilters,
  "sort": GetOrdersSort,
  "page": 123,
  "limit": 123
}

Types

GetOrdersResponse

Fields

Field Name	Description
`orders` - `[Order]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "orders": [Order],
  "total": 123,
  "page": 987,
  "limit": 987
}

Types

GetOrdersSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "xyz789",
  "direction": "xyz789"
}

Types

GetProductParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

GetProductResponse

Fields

Field Name	Description
`product` - `Product!`

Example

{"product": Product}

Types

GetProductsFilters

Fields

Input Field	Description
`search` - `String`

Example

{"search": "xyz789"}

Types

GetProductsParams

Fields

Input Field	Description
`filters` - `GetProductsFilters`
`sort` - `GetProductsSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetProductsFilters,
  "sort": GetProductsSort,
  "page": 123,
  "limit": 123
}

Types

GetProductsResponse

Fields

Field Name	Description
`products` - `[Product]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "products": [Product],
  "total": 987,
  "page": 123,
  "limit": 123
}

Types

GetProductsSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "xyz789",
  "direction": "abc123"
}

Types

GetPurchaseOrderByBoxIdParams

Fields

Input Field	Description
`boxId` - `Int!`

Example

{"boxId": 123}

Types

GetPurchaseOrderByBoxIdResponse

Fields

Field Name	Description
`order` - `Order!`

Example

{"order": Order}

Types

GetRecommendedWarehouseSpotParams

Fields

Input Field	Description
`warehouseId` - `Int!`
`type` - `Int!`

Example

{"warehouseId": 987, "type": 987}

Types

GetRecommendedWarehouseSpotResponse

Fields

Field Name	Description
`warehouseSpot` - `WarehouseSpot!`

Example

{"warehouseSpot": WarehouseSpot}

Types

GetReturnLabelsFilters

Fields

Input Field	Description
`search` - `String`
`status` - `[Int!]`
`boxId` - `[Int!]`
`warehouseId` - `[Int!]`

Example

{
  "search": "abc123",
  "status": [987],
  "boxId": [123],
  "warehouseId": [987]
}

Types

GetReturnLabelsParams

Fields

Input Field	Description
`filters` - `GetReturnLabelsFilters`
`sort` - `GetReturnLabelsSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetReturnLabelsFilters,
  "sort": GetReturnLabelsSort,
  "page": 123,
  "limit": 987
}

Types

GetReturnLabelsResponse

Fields

Field Name	Description
`returnLabels` - `[ReturnLabel]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "returnLabels": [ReturnLabel],
  "total": 123,
  "page": 987,
  "limit": 987
}

Types

GetReturnLabelsSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "abc123",
  "direction": "abc123"
}

Types

GetShoppingCartParams

Fields

Input Field	Description
`externalId` - `String`
`cartId` - `Int`	(Deprecated) Use externalId instead of cartId
`anonymousId` - `String`

Example

{
  "externalId": "xyz789",
  "cartId": 987,
  "anonymousId": "xyz789"
}

Types

GetStatisticsParams

Fields

Input Field	Description
`timezone` - `String`

Example

{"timezone": "xyz789"}

Types

GetStatisticsResponse

Fields

Field Name	Description
`orders` - `OrderStatistics!`
`renewals` - `OrderStatistics!`
`retrievals` - `OrderStatistics!`
`customers` - `CustomerStatistics!`
`boxes` - `BoxStatistics!`

Example

{
  "orders": OrderStatistics,
  "renewals": OrderStatistics,
  "retrievals": OrderStatistics,
  "customers": CustomerStatistics,
  "boxes": BoxStatistics
}

Types

GetTimelineFilters

Fields

Input Field	Description
`customerId` - `Int!`

Example

{"customerId": 987}

Types

GetTimelineParams

Fields

Input Field	Description
`filters` - `GetTimelineFilters!`
`sort` - `GetTimelineSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetTimelineFilters,
  "sort": GetTimelineSort,
  "page": 987,
  "limit": 987
}

Types

GetTimelineResponse

Fields

Field Name	Description
`timelineEvents` - `[BoxHistory]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "timelineEvents": [BoxHistory],
  "total": 123,
  "page": 987,
  "limit": 123
}

Types

GetTimelineSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "xyz789",
  "direction": "abc123"
}

Types

GetTrackingDetailParams

Fields

Input Field	Description
`boxId` - `Int!`
`id` - `Int!`

Example

{"boxId": 987, "id": 987}

Types

GetTrackingDetailResponse

Fields

Field Name	Description
`trackingDetail` - `TrackingDetail!`

Example

{"trackingDetail": TrackingDetail}

Types

GetTrackingDetailsFilters

Fields

Input Field	Description
`boxId` - `Int`
`type` - `Int`
`status` - `Int`

Example

{"boxId": 987, "type": 987, "status": 987}

Types

GetTrackingDetailsParams

Fields

Input Field	Description
`filters` - `GetTrackingDetailsFilters`
`sort` - `GetTrackingDetailsSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetTrackingDetailsFilters,
  "sort": GetTrackingDetailsSort,
  "page": 123,
  "limit": 123
}

Types

GetTrackingDetailsResponse

Fields

Field Name	Description
`trackingDetails` - `[TrackingDetail]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "trackingDetails": [TrackingDetail],
  "total": 987,
  "page": 987,
  "limit": 987
}

Types

GetTrackingDetailsSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "xyz789",
  "direction": "xyz789"
}

Types

GetTransactionsFilters

Fields

Input Field	Description
`customerIds` - `[Int]`
`orderIds` - `[Int]`
`orderTypes` - `[Int]`
`skus` - `[String]`
`boxIds` - `[Int]`
`types` - `[Int]`
`statuses` - `[Int]`

Example

{
  "customerIds": [123],
  "orderIds": [987],
  "orderTypes": [987],
  "skus": ["abc123"],
  "boxIds": [987],
  "types": [123],
  "statuses": [123]
}

Types

GetTransactionsParams

Fields

Input Field	Description
`filters` - `GetTransactionsFilters`
`sort` - `GetTransactionsSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetTransactionsFilters,
  "sort": GetTransactionsSort,
  "page": 123,
  "limit": 987
}

Types

GetTransactionsResponse

Fields

Field Name	Description
`transactions` - `[BillingManagementTransaction]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "transactions": [BillingManagementTransaction],
  "total": 123,
  "page": 123,
  "limit": 987
}

Types

GetTransactionsSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "xyz789",
  "direction": "xyz789"
}

Types

GetWarehouseParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

GetWarehouseResponse

Fields

Field Name	Description
`warehouse` - `Warehouse!`

Example

{"warehouse": Warehouse}

Types

GetWarehouseSpotParams

Fields

Input Field	Description
`warehouseId` - `Int!`
`id` - `Int!`

Example

{"warehouseId": 987, "id": 987}

Types

GetWarehouseSpotResponse

Fields

Field Name	Description
`warehouseSpot` - `WarehouseSpot!`

Example

{"warehouseSpot": WarehouseSpot}

Types

GetWarehouseSpotsFilters

Fields

Input Field	Description
`warehouseId` - `Int!`
`search` - `String`
`type` - `Int`

Example

{
  "warehouseId": 123,
  "search": "abc123",
  "type": 987
}

Types

GetWarehouseSpotsParams

Fields

Input Field	Description
`filters` - `GetWarehouseSpotsFilters!`
`sort` - `GetWarehouseSpotsSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetWarehouseSpotsFilters,
  "sort": GetWarehouseSpotsSort,
  "page": 987,
  "limit": 987
}

Types

GetWarehouseSpotsResponse

Fields

Field Name	Description
`warehouseSpots` - `[WarehouseSpot]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "warehouseSpots": [WarehouseSpot],
  "total": 123,
  "page": 123,
  "limit": 987
}

Types

GetWarehouseSpotsSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "abc123",
  "direction": "xyz789"
}

Types

GetWarehousesFilters

Fields

Input Field	Description
`search` - `String`
`status` - `Int`

Example

{"search": "abc123", "status": 123}

Types

GetWarehousesParams

Fields

Input Field	Description
`filters` - `GetWarehousesFilters`
`sort` - `GetWarehousesSort`
`page` - `Int`
`limit` - `Int`

Example

{
  "filters": GetWarehousesFilters,
  "sort": GetWarehousesSort,
  "page": 987,
  "limit": 123
}

Types

GetWarehousesResponse

Fields

Field Name	Description
`warehouses` - `[Warehouse]!`
`total` - `Int!`
`page` - `Int!`
`limit` - `Int!`

Example

{
  "warehouses": [Warehouse],
  "total": 987,
  "page": 987,
  "limit": 123
}

Types

GetWarehousesSort

Fields

Input Field	Description
`field` - `String!`
`direction` - `String!`

Example

{
  "field": "xyz789",
  "direction": "xyz789"
}

Types

IncludeCustomerToCustomerGroupParams

Fields

Input Field	Description
`customerId` - `Int!`
`customerGroupId` - `Int!`

Example

{"customerId": 123, "customerGroupId": 123}

Types

InductBoxesParams

Fields

Input Field	Description
`warehouseId` - `Int!`
`qty` - `Int!`
`boxTypeId` - `Int!`

Example

{"warehouseId": 987, "qty": 987, "boxTypeId": 987}

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

Types

IntercomHashes

Fields

Field Name	Description
`ios` - `String`
`android` - `String`
`web` - `String`

Example

{
  "ios": "abc123",
  "android": "abc123",
  "web": "abc123"
}

Types

JSON

Example

{}

Types

LockBoxParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 987}

Types

LockBoxResponse

Fields

Field Name	Description
`box` - `Box!`

Example

{"box": Box}

Types

MembershipStatus

Values

Enum Value	Description
`ACTIVE`
`INACTIVE`

Example

"ACTIVE"

Types

MonthlyStorageError

Fields

Field Name	Description
`id` - `Int!`
`message` - `String!`
`customerId` - `Int`
`paymentProviderId` - `String`
`defaultPaymentId` - `String`
`amount` - `Float`
`createdAt` - `Date!`
`updatedAt` - `Date!`
`customer` - `Customer`

Example

{
  "id": 123,
  "message": "xyz789",
  "customerId": 987,
  "paymentProviderId": "abc123",
  "defaultPaymentId": "xyz789",
  "amount": 123.45,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "customer": Customer
}

Types

Note

Fields

Field Name	Description
`id` - `Int`
`modelType` - `NoteModelType`
`modelId` - `Int`
`author` - `String`
`content` - `String`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 987,
  "modelType": "Box",
  "modelId": 123,
  "author": "xyz789",
  "content": "xyz789",
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

NoteModelType

Values

Enum Value	Description
`Box`
`SalesOrder`
`TrackingDetail`

Example

"Box"

Types

Order

Fields

Field Name	Description
`id` - `Int`
`incrementId` - `String`
`customerId` - `Int`
`total` - `Float`
`status` - `Int`
`type` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`
`customer` - `OrderCustomer`
`items` - `[OrderItem]`
`shippingAddress` - `OrderShippingAddress`
`shippingAddressChanges` - `[OrderShippingAddressChange]`
`transactions` - `[OrderTransaction]`
`shippingDetails` - `[OrderShippingDetail]`
`warehouseId` - `Int`
`warehouse` - `Warehouse`
`discountCouponSnapshot` - `OrderDiscountCouponSnapshot`
`customerGroupDiscountSnapshot` - `OrderCustomerGroupDiscountSnapshot`
`origin` - `OrderOrigin`
`receipts` - `[Receipt]!`
`returnLabels` - `[ReturnLabel]`

Example

{
  "id": 987,
  "incrementId": "abc123",
  "customerId": 987,
  "total": 123.45,
  "status": 123,
  "type": 987,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "customer": OrderCustomer,
  "items": [OrderItem],
  "shippingAddress": OrderShippingAddress,
  "shippingAddressChanges": [OrderShippingAddressChange],
  "transactions": [OrderTransaction],
  "shippingDetails": [OrderShippingDetail],
  "warehouseId": 987,
  "warehouse": Warehouse,
  "discountCouponSnapshot": OrderDiscountCouponSnapshot,
  "customerGroupDiscountSnapshot": OrderCustomerGroupDiscountSnapshot,
  "origin": "WEB",
  "receipts": [Receipt],
  "returnLabels": [ReturnLabel]
}

Types

OrderCustomer

Fields

Field Name	Description
`id` - `Int`
`phone` - `String`
`email` - `String`
`paymentProviderId` - `String`
`defaultPaymentId` - `String`
`firstName` - `String`
`lastName` - `String`
`status` - `Int`
`picture` - `String`

Example

{
  "id": 123,
  "phone": "abc123",
  "email": "abc123",
  "paymentProviderId": "xyz789",
  "defaultPaymentId": "xyz789",
  "firstName": "abc123",
  "lastName": "xyz789",
  "status": 123,
  "picture": "abc123"
}

Types

OrderCustomerGroupDiscountSnapshot

Fields

Field Name	Description
`id` - `Int`
`orderId` - `Int`
`customerGroupId` - `Int`
`name` - `String`
`paymentMethodRequired` - `Boolean`
`purchaseFeeDiscountType` - `CustomerGroupDiscountType`
`purchaseFeeDiscountAmount` - `Int`
`storageFeeDiscountType` - `CustomerGroupDiscountType`
`storageFeeDiscountAmount` - `Int`
`excessWeightFeeDiscountType` - `CustomerGroupDiscountType`
`excessWeightFeeDiscountAmount` - `Int`
`returnToUserFeeDiscountType` - `CustomerGroupDiscountType`
`returnToUserFeeDiscountAmount` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 987,
  "orderId": 987,
  "customerGroupId": 987,
  "name": "abc123",
  "paymentMethodRequired": true,
  "purchaseFeeDiscountType": "PERCENTAGE",
  "purchaseFeeDiscountAmount": 987,
  "storageFeeDiscountType": "PERCENTAGE",
  "storageFeeDiscountAmount": 123,
  "excessWeightFeeDiscountType": "PERCENTAGE",
  "excessWeightFeeDiscountAmount": 123,
  "returnToUserFeeDiscountType": "PERCENTAGE",
  "returnToUserFeeDiscountAmount": 987,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

OrderDiscountCouponSnapshot

Fields

Field Name	Description
`id` - `Int`
`orderId` - `Int`
`discountCouponId` - `Int`
`code` - `String`
`type` - `Int`
`amount` - `Float`
`limit` - `Int`
`minimumPurchaseAmount` - `Int`
`maximumPurchaseAmount` - `Int`
`startDate` - `Date`
`endDate` - `Date`
`isUnlimited` - `Boolean`
`minimumBoxesAmount` - `Int`
`applyToRecurrentPayments` - `Boolean`

Example

{
  "id": 987,
  "orderId": 987,
  "discountCouponId": 987,
  "code": "abc123",
  "type": 123,
  "amount": 987.65,
  "limit": 123,
  "minimumPurchaseAmount": 987,
  "maximumPurchaseAmount": 123,
  "startDate": "2007-12-03",
  "endDate": "2007-12-03",
  "isUnlimited": true,
  "minimumBoxesAmount": 987,
  "applyToRecurrentPayments": false
}

Types

OrderItem

Fields

Field Name	Description
`id` - `Int`
`orderId` - `Int`
`quantity` - `Int`
`price` - `Float`
`priceWithDiscount` - `Float`
`total` - `Float`
`totalWithDiscount` - `Float`
`status` - `Int`
`description` - `String`
`productId` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`
`productSku` - `String`
`boxTypeName` - `String`
`boxes` - `[Box]`
`boxQuantity` - `Int`
`title` - `String`

Example

{
  "id": 123,
  "orderId": 987,
  "quantity": 123,
  "price": 123.45,
  "priceWithDiscount": 987.65,
  "total": 987.65,
  "totalWithDiscount": 123.45,
  "status": 987,
  "description": "xyz789",
  "productId": 987,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "productSku": "xyz789",
  "boxTypeName": "xyz789",
  "boxes": [Box],
  "boxQuantity": 987,
  "title": "abc123"
}

Types

OrderOrigin

Values

Enum Value	Description
`WEB`
`IOS`
`ANDROID`
`SYSTEM`
`UNKNOWN`

Example

"WEB"

Types

OrderShippingAddress

Fields

Field Name	Description
`id` - `Int`
`orderId` - `Int`
`customerName` - `String`
`street1` - `String`
`street2` - `String`
`city` - `String`
`state` - `String`
`zipcode` - `String`
`country` - `String`
`residential` - `Boolean`
`instructions` - `String`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 123,
  "orderId": 123,
  "customerName": "xyz789",
  "street1": "abc123",
  "street2": "xyz789",
  "city": "abc123",
  "state": "abc123",
  "zipcode": "abc123",
  "country": "xyz789",
  "residential": true,
  "instructions": "xyz789",
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

OrderShippingAddressChange

Fields

Field Name	Description
`id` - `Int`
`orderId` - `Int`
`previousCustomerName` - `String`
`previousStreet1` - `String`
`previousStreet2` - `String`
`previousCity` - `String`
`previousState` - `String`
`previousZipcode` - `String`
`previousCountry` - `String`
`previousResidential` - `Boolean`
`previousInstructions` - `String`
`newCustomerName` - `String`
`newStreet1` - `String`
`newStreet2` - `String`
`newCity` - `String`
`newState` - `String`
`newZipcode` - `String`
`newCountry` - `String`
`newResidential` - `Boolean`
`newInstructions` - `String`
`previousTrackingNumbers` - `[String]`
`previousLabelUrls` - `[String]`
`requestedBy` - `String`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 123,
  "orderId": 123,
  "previousCustomerName": "xyz789",
  "previousStreet1": "xyz789",
  "previousStreet2": "xyz789",
  "previousCity": "abc123",
  "previousState": "abc123",
  "previousZipcode": "abc123",
  "previousCountry": "abc123",
  "previousResidential": true,
  "previousInstructions": "abc123",
  "newCustomerName": "xyz789",
  "newStreet1": "abc123",
  "newStreet2": "xyz789",
  "newCity": "abc123",
  "newState": "xyz789",
  "newZipcode": "xyz789",
  "newCountry": "xyz789",
  "newResidential": false,
  "newInstructions": "xyz789",
  "previousTrackingNumbers": ["abc123"],
  "previousLabelUrls": ["xyz789"],
  "requestedBy": "xyz789",
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

OrderShippingDetail

Fields

Field Name	Description
`id` - `Int`
`orderId` - `Int`
`trackingNumber` - `String`
`labelUrl` - `String`
`type` - `Int`
`status` - `Int`
`serviceType` - `String`
`serviceName` - `String`
`priceInCents` - `Int`
`shippedAt` - `Date`
`estimatedDeliveryDate` - `Date`
`deliveredAt` - `Date`
`scheduledAt` - `Date`
`customerCloseTime` - `String`
`notes` - `String`
`instructions` - `String`
`confirmationCode` - `String`
`printedAt` - `Date`
`directSignatureRequired` - `Boolean`
`expectedDeliveryDate` - `Date`
`recommendedShippingDate` - `Date`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 123,
  "orderId": 987,
  "trackingNumber": "xyz789",
  "labelUrl": "xyz789",
  "type": 123,
  "status": 123,
  "serviceType": "xyz789",
  "serviceName": "abc123",
  "priceInCents": 123,
  "shippedAt": "2007-12-03",
  "estimatedDeliveryDate": "2007-12-03",
  "deliveredAt": "2007-12-03",
  "scheduledAt": "2007-12-03",
  "customerCloseTime": "abc123",
  "notes": "xyz789",
  "instructions": "xyz789",
  "confirmationCode": "abc123",
  "printedAt": "2007-12-03",
  "directSignatureRequired": true,
  "expectedDeliveryDate": "2007-12-03",
  "recommendedShippingDate": "2007-12-03",
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

OrderStatistics

Fields

Field Name	Description
`today` - `Int`
`yesterday` - `Int`
`week` - `Int`
`lastWeek` - `Int`
`month` - `Int`
`lastMonth` - `Int`

Example

{
  "today": 123,
  "yesterday": 987,
  "week": 987,
  "lastWeek": 987,
  "month": 123,
  "lastMonth": 987
}

Types

OrderTransaction

Fields

Field Name	Description
`id` - `Int`
`debitAmount` - `Float`
`creditAmount` - `Float`
`totalAmount` - `Float`
`type` - `Int`
`status` - `Int`
`paymentMethod` - `Int`
`paymentProviderTransactionId` - `String`
`account` - `String`
`description` - `String`
`notes` - `String`
`orderId` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 987,
  "debitAmount": 123.45,
  "creditAmount": 123.45,
  "totalAmount": 987.65,
  "type": 123,
  "status": 987,
  "paymentMethod": 123,
  "paymentProviderTransactionId": "xyz789",
  "account": "xyz789",
  "description": "xyz789",
  "notes": "abc123",
  "orderId": 987,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

PackBoxParams

Fields

Input Field	Description
`id` - `Int!`	Box ID
`returnLabelIdentifier` - `String!`	Label tracking number (external_id)

Example

{
  "id": 987,
  "returnLabelIdentifier": "xyz789"
}

Types

PackBoxResponse

Fields

Field Name	Description
`box` - `Box!`

Example

{"box": Box}

Types

PaymentMethodType

Values

Enum Value	Description
`CREDIT_CARD`
`APPLE_PAY`
`PAYPAL`
`GOOGLE_PAY`

Example

"CREDIT_CARD"

Types

PickUpAddress

Fields

Input Field	Description
`customerName` - `String!`
`customerPhone` - `String!`
`street1` - `String!`
`street2` - `String`
`city` - `String!`
`state` - `String!`
`zipcode` - `String!`
`country` - `String!`
`residential` - `Boolean`

Example

{
  "customerName": "xyz789",
  "customerPhone": "xyz789",
  "street1": "abc123",
  "street2": "xyz789",
  "city": "xyz789",
  "state": "abc123",
  "zipcode": "xyz789",
  "country": "abc123",
  "residential": false
}

Types

Price

Fields

Field Name	Description
`id` - `Int`
`status` - `Int`
`purchaseAmount` - `Int`
`recurrentAmount` - `Int`
`currency` - `Currency`
`minStoragePeriodAmount` - `Int`
`minStoragePeriodUnit` - `Int`
`includedStoragePeriodAmount` - `Int`
`includedStoragePeriodUnit` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`

Possible Types

Price Types
`BoxPrice`
`ProductPrice`

Example

{
  "id": 987,
  "status": 987,
  "purchaseAmount": 123,
  "recurrentAmount": 987,
  "currency": "USD",
  "minStoragePeriodAmount": 123,
  "minStoragePeriodUnit": 987,
  "includedStoragePeriodAmount": 123,
  "includedStoragePeriodUnit": 987,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

PriceStatus

Values

Enum Value	Description
`Active`
`Inactive`

Example

"Active"

Types

PriceTierQuantityRules

Fields

Field Name	Description
`id` - `Int!`
`productId` - `Int!`
`name` - `String`
`description` - `String`
`minQuantity` - `Int!`
`maxQuantity` - `Int`
`recurrentAmount` - `Int!`
`purchaseAmount` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 123,
  "productId": 987,
  "name": "abc123",
  "description": "abc123",
  "minQuantity": 987,
  "maxQuantity": 123,
  "recurrentAmount": 987,
  "purchaseAmount": 987,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

ProcessOrderBoxInput

Fields

Input Field	Description
`id` - `Int!`	The box id
`serialNumber` - `String!`	The serial number to be assigned to the box
`returnLabel` - `String!`	The tracking number of the return label to be assigned to the box

Example

{
  "id": 123,
  "serialNumber": "xyz789",
  "returnLabel": "xyz789"
}

Types

ProcessOrderParams

Fields

Input Field	Description
`id` - `Int!`	The order id
`boxList` - `[ProcessOrderBoxInput]!`	The list of boxes to process

Example

{"id": 987, "boxList": [ProcessOrderBoxInput]}

Types

ProcessOrderResponse

Fields

Field Name	Description
`order` - `Order!`

Example

{"order": Order}

Types

ProcessPurchaseOrderBoxInput

Fields

Input Field	Description
`id` - `Int!`	The box id
`serialNumber` - `String!`	The serial number to be assigned to the box
`returnLabel` - `String!`	The tracking number of the return label to be assigned to the box

Example

{
  "id": 987,
  "serialNumber": "abc123",
  "returnLabel": "abc123"
}

Types

ProcessPurchaseOrderParams

Fields

Input Field	Description
`id` - `Int!`	The order id
`boxList` - `[ProcessPurchaseOrderBoxInput]!`	The list of boxes to process

Example

{"id": 123, "boxList": [ProcessPurchaseOrderBoxInput]}

Types

ProcessPurchaseOrderResponse

Fields

Field Name	Description
`order` - `Order!`

Example

{"order": Order}

Types

ProcessRTUOrderBoxInput

Fields

Input Field	Description
`id` - `Int!`	The box id
`serialNumber` - `String!`	The serial number of the box
`returnLabel` - `String!`	The tracking number of the return label to be assigned to the box
`weight` - `Float!`	The weight of the box in pounds
`hasOverweightFee` - `Boolean!`	Indicates if the box has an overweight fee

Example

{
  "id": 123,
  "serialNumber": "xyz789",
  "returnLabel": "xyz789",
  "weight": 987.65,
  "hasOverweightFee": true
}

Types

ProcessRTUOrderParams

Fields

Input Field	Description
`id` - `Int!`	The order id
`boxList` - `[ProcessRTUOrderBoxInput!]!`	The list of boxes to process
`checkWeightThreshold` - `Boolean`	If true, the weight of the boxes will be checked against the weight threshold

Example

{
  "id": 987,
  "boxList": [ProcessRTUOrderBoxInput],
  "checkWeightThreshold": true
}

Types

Product

Fields

Field Name	Description
`id` - `Int`
`sku` - `String`
`status` - `Int`
`title` - `String`
`description` - `String`
`shortDescription` - `String`
`urlKey` - `String`
`seoTitle` - `String`
`seoDescription` - `String`
`seoKeywords` - `String`
`boxTypeId` - `Int`
`quantity` - `Int`	Inventory quantity of the product
`boxQuantity` - `Int`
`type` - `Int`
`isMostPopular` - `Boolean`
`isStarterKit` - `Boolean`
`createdAt` - `Date`
`updatedAt` - `Date`
`boxType` - `BoxType`
`priceList` - `[ProductPrice]`
`activePrice` - `ProductPrice`
`defaultPrice` - `ProductPrice`
`imageList` - `[ProductImage]`
`price` - `Float`	(Deprecated) This field is deprecated and will be removed in future versions. Use `priceList` instead
`images` - `JSON`	(Deprecated) This field is deprecated and will be removed in future versions. Use `imageList` instead
`priceTierQuantityRules` - `[PriceTierQuantityRules]`	Price tier quantity rules

Example

{
  "id": 987,
  "sku": "abc123",
  "status": 987,
  "title": "xyz789",
  "description": "abc123",
  "shortDescription": "abc123",
  "urlKey": "xyz789",
  "seoTitle": "abc123",
  "seoDescription": "xyz789",
  "seoKeywords": "xyz789",
  "boxTypeId": 123,
  "quantity": 123,
  "boxQuantity": 987,
  "type": 987,
  "isMostPopular": true,
  "isStarterKit": false,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "boxType": BoxType,
  "priceList": [ProductPrice],
  "activePrice": ProductPrice,
  "defaultPrice": ProductPrice,
  "imageList": [ProductImage],
  "price": 123.45,
  "images": {},
  "priceTierQuantityRules": [PriceTierQuantityRules]
}

Types

ProductImage

Fields

Field Name	Description
`id` - `Int`
`productId` - `Int`
`label` - `String`
`alt` - `String`
`url` - `String`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 987,
  "productId": 987,
  "label": "xyz789",
  "alt": "xyz789",
  "url": "xyz789",
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

ProductImageUpdateParams

Fields

Input Field	Description
`id` - `Int!`
`label` - `String`
`alt` - `String`

Example

{
  "id": 987,
  "label": "abc123",
  "alt": "abc123"
}

Types

ProductPrice

Fields

Field Name	Description
`id` - `Int`
`productId` - `Int`
`status` - `Int`
`purchaseAmount` - `Int`
`recurrentAmount` - `Int`
`currency` - `Currency`
`minStoragePeriodAmount` - `Int`
`minStoragePeriodUnit` - `Int`
`includedStoragePeriodAmount` - `Int`
`includedStoragePeriodUnit` - `Int`
`isDefault` - `Boolean`
`validFrom` - `Date`
`validUntil` - `Date`
`promotionName` - `String`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 987,
  "productId": 123,
  "status": 123,
  "purchaseAmount": 987,
  "recurrentAmount": 987,
  "currency": "USD",
  "minStoragePeriodAmount": 123,
  "minStoragePeriodUnit": 987,
  "includedStoragePeriodAmount": 123,
  "includedStoragePeriodUnit": 123,
  "isDefault": true,
  "validFrom": "2007-12-03",
  "validUntil": "2007-12-03",
  "promotionName": "abc123",
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

ProductPriceInput

Fields

Input Field	Description
`productId` - `Int`
`status` - `PriceStatus`
`purchaseAmount` - `Int`
`recurrentAmount` - `Int`
`currency` - `Currency`
`minStoragePeriodAmount` - `Int`	This field will be set internally
`minStoragePeriodUnit` - `StoragePeriodUnit`	This field will be set internally
`includedStoragePeriodAmount` - `Int`	This field will be set internally
`includedStoragePeriodUnit` - `StoragePeriodUnit`	This field will be set internally
`isDefault` - `Boolean`
`validFrom` - `Date`
`validUntil` - `Date`
`promotionName` - `String`

Example

{
  "productId": 987,
  "status": "Active",
  "purchaseAmount": 123,
  "recurrentAmount": 987,
  "currency": "USD",
  "minStoragePeriodAmount": 987,
  "minStoragePeriodUnit": "DAY",
  "includedStoragePeriodAmount": 123,
  "includedStoragePeriodUnit": "DAY",
  "isDefault": true,
  "validFrom": "2007-12-03",
  "validUntil": "2007-12-03",
  "promotionName": "abc123"
}

Types

ProductPriceUpdate

Fields

Input Field	Description
`id` - `Int!`
`status` - `PriceStatus`
`purchaseAmount` - `Int`
`recurrentAmount` - `Int`
`currency` - `Currency`
`minStoragePeriodAmount` - `Int`	This field will be set internally
`minStoragePeriodUnit` - `StoragePeriodUnit`	This field will be set internally
`includedStoragePeriodAmount` - `Int`	This field will be set internally
`includedStoragePeriodUnit` - `StoragePeriodUnit`	This field will be set internally
`isDefault` - `Boolean`
`validFrom` - `Date`
`validUntil` - `Date`
`promotionName` - `String`

Example

{
  "id": 987,
  "status": "Active",
  "purchaseAmount": 123,
  "recurrentAmount": 987,
  "currency": "USD",
  "minStoragePeriodAmount": 987,
  "minStoragePeriodUnit": "DAY",
  "includedStoragePeriodAmount": 123,
  "includedStoragePeriodUnit": "DAY",
  "isDefault": false,
  "validFrom": "2007-12-03",
  "validUntil": "2007-12-03",
  "promotionName": "xyz789"
}

Types

ProductType

Values

Enum Value	Description
`BOX`
`ANCILLARY`

Example

"BOX"

Types

Receipt

Fields

Field Name	Description
`id` - `Int`
`fileUrl` - `String`
`transactionId` - `Int`
`orderId` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 123,
  "fileUrl": "abc123",
  "transactionId": 123,
  "orderId": 123,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

ReceiveBoxParams

Fields

Input Field	Description
`warehouseId` - `Int!`
`serialNumber` - `String!`
`weight` - `Float!`
`chargeExcessWeight` - `Boolean!`

Example

{
  "warehouseId": 123,
  "serialNumber": "xyz789",
  "weight": 987.65,
  "chargeExcessWeight": false
}

Types

ReceiveBoxResponse

Fields

Field Name	Description
`box` - `Box!`

Example

{"box": Box}

Types

ReconcileOpenOrderParams

Fields

Input Field	Description
`orderId` - `Int!`

Example

{"orderId": 987}

Types

ReconcileOpenOrderResponse

Fields

Field Name	Description
`orderId` - `Int!`
`affectedTrackingNumbers` - `[String!]!`
`updated` - `Boolean!`
`previousStatus` - `Int!`
`newStatus` - `Int!`

Example

{
  "orderId": 987,
  "affectedTrackingNumbers": ["abc123"],
  "updated": true,
  "previousStatus": 987,
  "newStatus": 123
}

Types

ReconcileOpenTrackingDetailParams

Fields

Input Field	Description
`trackingDetailId` - `Int!`

Example

{"trackingDetailId": 123}

Types

ReconcileOpenTrackingDetailResponse

Fields

Field Name	Description
`trackingDetailId` - `Int!`
`affectedTrackingNumbers` - `[String!]!`
`updated` - `Boolean!`
`previousStatus` - `Int!`
`newStatus` - `Int!`

Example

{
  "trackingDetailId": 987,
  "affectedTrackingNumbers": ["abc123"],
  "updated": true,
  "previousStatus": 123,
  "newStatus": 123
}

Types

RefreshCustomerTokenParams

Fields

Input Field	Description
`refreshToken` - `String!`

Example

{"refreshToken": "xyz789"}

Types

RefreshCustomerTokenResponse

Fields

Field Name	Description
`token` - `String!`
`refreshToken` - `String!`
`user` - `Customer!`

Example

{
  "token": "abc123",
  "refreshToken": "xyz789",
  "user": Customer
}

Types

RejectCancellationRequestParams

Fields

Input Field	Description
`id` - `Int!`
`notes` - `String`

Example

{"id": 987, "notes": "abc123"}

Types

RejectCancellationRequestResponse

Fields

Field Name	Description
`cancellationRequest` - `CancellationRequest!`

Example

{"cancellationRequest": CancellationRequest}

Types

RejectMembershipCancellationRequestParams

Fields

Input Field	Description
`customerId` - `Int!`

Example

{"customerId": 123}

Types

RejectMembershipCancellationRequestResponse

Fields

Field Name	Description
`success` - `Boolean!`

Example

{"success": true}

Types

RemoveProductPriceParams

Fields

Input Field	Description
`id` - `Int!`	Price id

Example

{"id": 987}

Types

RemoveShoppingCartLineItemsParams

Fields

Input Field	Description
`externalId` - `String`
`cartId` - `Int`	(Deprecated) Use externalId instead of cartId
`itemIdList` - `[Int!]!`

Example

{
  "externalId": "abc123",
  "cartId": 987,
  "itemIdList": [987]
}

Types

RequestBoxCancellationBoxesToKeep

Fields

Input Field	Description
`boxIds` - `[Int!]!`
`paymentMethodId` - `String!`

Example

{
  "boxIds": [987],
  "paymentMethodId": "xyz789"
}

Types

RequestBoxCancellationBoxesToReturn

Fields

Input Field	Description
`pickUpInfo` - `CreatePickUpsParams`
`dropOffInfo` - `CreateDropOffsParams`

Example

{
  "pickUpInfo": CreatePickUpsParams,
  "dropOffInfo": CreateDropOffsParams
}

Types

RequestBoxCancellationParams

Fields

Input Field	Description
`boxesToKeep` - `RequestBoxCancellationBoxesToKeep`
`boxesToReturn` - `RequestBoxCancellationBoxesToReturn`
`reason` - `String`

Example

{
  "boxesToKeep": RequestBoxCancellationBoxesToKeep,
  "boxesToReturn": RequestBoxCancellationBoxesToReturn,
  "reason": "abc123"
}

Types

RequestBoxCancellationResponse

Fields

Field Name	Description
`order` - `Order`
`boxCancellationRequests` - `[CancellationRequest!]!`
`boxes` - `[Box!]!`
`trackingDetails` - `[TrackingDetail!]!`

Example

{
  "order": Order,
  "boxCancellationRequests": [CancellationRequest],
  "boxes": [Box],
  "trackingDetails": [TrackingDetail]
}

Types

ReschedulePickUpParams

Fields

Input Field	Description
`pickUpToBeCancelled` - `Int!`
`boxesToReschedulePickUp` - `[Int!]!`
`scheduledAt` - `String!`
`customerCloseTime` - `String!`
`pickUpAddressId` - `Int!`
`instructions` - `String`

Example

{
  "pickUpToBeCancelled": 123,
  "boxesToReschedulePickUp": [123],
  "scheduledAt": "abc123",
  "customerCloseTime": "abc123",
  "pickUpAddressId": 123,
  "instructions": "abc123"
}

Types

ReschedulePickUpResponse

Fields

Field Name	Description
`trackingDetails` - `[TrackingDetail!]!`

Example

{"trackingDetails": [TrackingDetail]}

Types

ResetSignUpParams

Fields

Input Field	Description
`credential` - `String!`

Example

{"credential": "abc123"}

Types

RetrieveBoxesParams

Fields

Input Field	Description
`boxIds` - `[Int!]!`
`shippingAddressId` - `Int!`
`creditCard` - `String`
`directSignatureRequired` - `Boolean`
`expectedDeliveryDate` - `String`	This will actually represent the expected shipping date. See reference in FLYBOX-1523

Example

{
  "boxIds": [987],
  "shippingAddressId": 123,
  "creditCard": "abc123",
  "directSignatureRequired": true,
  "expectedDeliveryDate": "xyz789"
}

Types

RetrieveBoxesResponse

Fields

Field Name	Description
`orders` - `[Order]!`

Example

{"orders": [Order]}

Types

ReturnLabel

Fields

Field Name	Description
`id` - `Int`
`externalId` - `String`
`url` - `String`
`status` - `Int`
`boxId` - `Int`
`warehouseId` - `Int`
`warehouse` - `Warehouse`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 123,
  "externalId": "abc123",
  "url": "abc123",
  "status": 987,
  "boxId": 123,
  "warehouseId": 987,
  "warehouse": Warehouse,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

Role

Fields

Field Name	Description
`code` - `String!`
`description` - `String!`

Example

{
  "code": "abc123",
  "description": "abc123"
}

Types

ScanBoxParams

Fields

Input Field	Description
`targetBoxId` - `Int`	ID of the box that should receive the serial number and/or the return label. Provide this field when you need to explicitly specify which box should be updated with the serial number and/or return label.
`serialNumber` - `String!`
`returnLabelIdentifier` - `String`

Example

{
  "targetBoxId": 987,
  "serialNumber": "abc123",
  "returnLabelIdentifier": "abc123"
}

Types

ScanBoxResponse

Fields

Field Name	Description
`box` - `Box!`

Example

{"box": Box}

Types

ServiceTypes

Values

Enum Value	Description
`GROUND`
`PRIORITY_OVERNIGHT`

Example

"GROUND"

Types

SetDefaultPaymentMethodParams

Fields

Input Field	Description
`id` - `String!`

Example

{"id": "xyz789"}

Types

SetFirstScannedAtParams

Fields

Input Field	Description
`serialNumber` - `String!`

Example

{"serialNumber": "abc123"}

Types

SetFirstScannedAtResponse

Fields

Field Name	Description
`box` - `Box!`

Example

{"box": Box}

Types

SetShoppingCartDiscountCouponParams

Description

Params to set a discount coupon to the shopping cart. If you want to remove the discount coupon, set the couponCode to null.

Fields

Input Field	Description
`externalId` - `String`
`cartId` - `Int`	(Deprecated) Use externalId instead of cartId
`couponCode` - `String`

Example

{
  "externalId": "abc123",
  "cartId": 987,
  "couponCode": "xyz789"
}

Types

SetShoppingCartShippingAddressParams

Fields

Input Field	Description
`externalId` - `String`
`cartId` - `Int`	(Deprecated) Use externalId instead of cartId
`address` - `AddressInput!`

Example

{
  "externalId": "xyz789",
  "cartId": 123,
  "address": AddressInput
}

Types

ShoppingCart

Fields

Field Name	Description
`status` - `ShoppingCartStatus!`
`id` - `Int!`
`externalId` - `String`	External identifier for the shopping cart, used for public access or third-party integrations
`anonymousId` - `String`
`subtotalAmount` - `Int!`	Sum of line items in cents
`totalAmount` - `Int!`	Subtotal with discount applied in cents
`lineItemList` - `[ShoppingCartLineItem]!`
`shippingAddress` - `ShoppingCartShippingAddress`
`discountCoupon` - `DiscountCouponResult`
`discountAmount` - `Int!`	Discout amount in cents
`customer` - `ShoppingCartCustomer`
`createdAt` - `Date!`
`updatedAt` - `Date!`
`activeDiscount` - `ShoppingCartActiveDiscount`
`costs` - `ShoppingCartCost!`

Example

{
  "status": "OPEN",
  "id": 987,
  "externalId": "abc123",
  "anonymousId": "xyz789",
  "subtotalAmount": 987,
  "totalAmount": 987,
  "lineItemList": [ShoppingCartLineItem],
  "shippingAddress": ShoppingCartShippingAddress,
  "discountCoupon": DiscountCouponResult,
  "discountAmount": 123,
  "customer": ShoppingCartCustomer,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "activeDiscount": ShoppingCartActiveDiscount,
  "costs": ShoppingCartCost
}

Types

ShoppingCartActiveDiscount

Fields

Field Name	Description
`origin` - `ShoppingCartDiscountOrigin!`
`amount` - `Float!`
`type` - `ShoppingCartDiscountType!`
`code` - `String!`

Example

{
  "origin": "CUSTOMER_GROUP",
  "amount": 123.45,
  "type": "PERCENTAGE",
  "code": "abc123"
}

Types

ShoppingCartCost

Fields

Field Name	Description
`subtotalAmount` - `Int!`	Sum of line items gross price
`subtotalAmountWithLineItemsDiscount` - `Int!`	Sum of line items price with tier price applied
`cartDiscountAmount` - `Int!`	Cart level discount
`totalAmount` - `Int!`	Total amount including all discounts

Example

{
  "subtotalAmount": 987,
  "subtotalAmountWithLineItemsDiscount": 123,
  "cartDiscountAmount": 123,
  "totalAmount": 123
}

Types

ShoppingCartCustomer

Fields

Field Name	Description
`id` - `Int`
`phone` - `String`
`recurrenceBaseInMonths` - `Int`	This field is being migrated to the Subscription model. It now reads from the active subscription's billing frequency. Please plan to migrate to subscription-based fields in future releases.
`customerGroup` - `CustomerGroup`
`subscription` - `Subscription`

Example

{
  "id": 987,
  "phone": "abc123",
  "recurrenceBaseInMonths": 123,
  "customerGroup": CustomerGroup,
  "subscription": Subscription
}

Types

ShoppingCartDiscountOrigin

Values

Enum Value	Description
`CUSTOMER_GROUP`
`DISCOUNT_COUPON`
`NONE`

Example

"CUSTOMER_GROUP"

Types

ShoppingCartDiscountType

Values

Enum Value	Description
`PERCENTAGE`
`FIXED`
`NONE`

Example

"PERCENTAGE"

Types

ShoppingCartLineItem

Fields

Field Name	Description
`id` - `Int!`
`productId` - `Int!`
`purchaseAmount` - `Int!`	purchase amount in cents (same as the related product purchase amount)
`recurrentAmount` - `Int!`	recurrent amount in cents (same as the related product recurrent amount)
`totalRecurrentAmount` - `Int!`	recurrentAmount * quantity
`quantity` - `Int!`
`product` - `Product!`
`createdAt` - `Date!`
`updatedAt` - `Date!`
`priceTier` - `ShoppingCartLineItemPriceTier!`	Applied price tier

Example

{
  "id": 123,
  "productId": 123,
  "purchaseAmount": 123,
  "recurrentAmount": 123,
  "totalRecurrentAmount": 987,
  "quantity": 987,
  "product": Product,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "priceTier": ShoppingCartLineItemPriceTier
}

Types

ShoppingCartLineItemPriceTier

Fields

Field Name	Description
`name` - `String`
`description` - `String`
`recurrentAmount` - `Int!`
`purchaseAmount` - `Int!`
`recurringDiscount` - `Int!`
`purchaseDiscount` - `Int!`

Example

{
  "name": "xyz789",
  "description": "xyz789",
  "recurrentAmount": 123,
  "purchaseAmount": 987,
  "recurringDiscount": 987,
  "purchaseDiscount": 987
}

Types

ShoppingCartShippingAddress

Fields

Field Name	Description
`id` - `Int!`
`cartId` - `Int!`
`street1` - `String!`
`street2` - `String`
`city` - `String!`
`state` - `String!`
`zipcode` - `String!`
`country` - `String!`
`residential` - `Boolean`
`instructions` - `String`
`createdAt` - `Date!`
`updatedAt` - `Date!`

Example

{
  "id": 123,
  "cartId": 987,
  "street1": "xyz789",
  "street2": "abc123",
  "city": "abc123",
  "state": "abc123",
  "zipcode": "abc123",
  "country": "abc123",
  "residential": true,
  "instructions": "abc123",
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

ShoppingCartStatus

Values

Enum Value	Description
`OPEN`
`COMPLETED`
`ABANDONED`

Example

"OPEN"

Types

SignUpParams

Fields

Input Field	Description
`phone` - `String!`
`firstName` - `String`
`lastName` - `String`
`email` - `String`
`consentRecords` - `[ConsentRecordInput]`

Example

{
  "phone": "abc123",
  "firstName": "abc123",
  "lastName": "abc123",
  "email": "abc123",
  "consentRecords": [ConsentRecordInput]
}

Types

SignUpResponse

Fields

Field Name	Description
`customer` - `Customer!`

Example

{"customer": Customer}

Types

SimplifiedBoxInformation

Fields

Field Name	Description
`id` - `Int`
`barcodeId` - `Int`
`serialNumber` - `String`
`warehouseSpotId` - `Int`
`spotIdentifier` - `String`
`customerId` - `Int`
`customerFirstName` - `String`
`customerLastName` - `String`
`customerEmail` - `String`
`customerPhone` - `String`
`warehouseId` - `Int`
`warehouseName` - `String`

Example

{
  "id": 123,
  "barcodeId": 123,
  "serialNumber": "xyz789",
  "warehouseSpotId": 987,
  "spotIdentifier": "abc123",
  "customerId": 123,
  "customerFirstName": "xyz789",
  "customerLastName": "xyz789",
  "customerEmail": "xyz789",
  "customerPhone": "xyz789",
  "warehouseId": 123,
  "warehouseName": "xyz789"
}

Types

SortDirection

Values

Enum Value	Description
`ASC`
`DESC`

Example

"ASC"

Types

StoragePeriodUnit

Values

Enum Value	Description
`DAY`
`MONTH`
`YEAR`

Example

"DAY"

Types

StoreBoxParams

Fields

Input Field	Description
`serialNumber` - `String!`
`warehouseSpotIdentifier` - `String!`

Example

{
  "serialNumber": "abc123",
  "warehouseSpotIdentifier": "xyz789"
}

Types

StoreBoxResponse

Fields

Field Name	Description
`box` - `Box!`

Example

{"box": Box}

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

SubscriptionPlan

Fields

Field Name	Description
`id` - `Int`
`name` - `String`
`description` - `String`
`status` - `SubscriptionPlanStatus`
`billingFrequency` - `SubscriptionPlanBillingFrequency`
`billingFrequencyInMonths` - `Int`
`renewalFrequency` - `SubscriptionPlanRenewalFrequency`
`renewalFrequencyInMonths` - `Int`
`minDurationInMonths` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 123,
  "name": "xyz789",
  "description": "xyz789",
  "status": "ACTIVE",
  "billingFrequency": "MONTHLY",
  "billingFrequencyInMonths": 987,
  "renewalFrequency": "MONTHLY",
  "renewalFrequencyInMonths": 987,
  "minDurationInMonths": 987,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

SubscriptionPlanBillingFrequency

Values

Enum Value	Description
`MONTHLY`
`QUARTERLY`

Example

"MONTHLY"

Types

SubscriptionPlanRenewalFrequency

Values

Enum Value	Description
`MONTHLY`
`QUARTERLY`

Example

"MONTHLY"

Types

SubscriptionPlanStatus

Values

Enum Value	Description
`ACTIVE`
`INACTIVE`

Example

"ACTIVE"

Types

SubscriptionStatus

Values

Enum Value	Description
`ACTIVE`
`CANCELLATION_IN_PROGRESS`
`CANCELLED`
`PAUSED`
`PAST_DUE`

Example

"ACTIVE"

Types

ToggleWarehouseSpotsStatusesParams

Fields

Input Field	Description
`spotIdentifiers` - `[String!]!`

Example

{"spotIdentifiers": ["abc123"]}

Types

TrackingDetail

Fields

Field Name	Description
`id` - `Int`
`boxId` - `Int`
`trackingNumber` - `String`
`type` - `Int`
`status` - `Int`
`shippedAt` - `Date`
`estimatedDeliveryDate` - `Date`
`deliveredAt` - `Date`
`scheduledAt` - `Date`
`customerCloseTime` - `String`
`notes` - `String`
`instructions` - `String`
`confirmationCode` - `String`
`createdAt` - `Date`
`updatedAt` - `Date`
`addresses` - `[TrackingDetailAddress]`
`warehouseId` - `Int`
`scheduledAtInUtc` - `Date`
`customerCloseTimeInUtc` - `Date`

Example

{
  "id": 987,
  "boxId": 123,
  "trackingNumber": "xyz789",
  "type": 123,
  "status": 987,
  "shippedAt": "2007-12-03",
  "estimatedDeliveryDate": "2007-12-03",
  "deliveredAt": "2007-12-03",
  "scheduledAt": "2007-12-03",
  "customerCloseTime": "abc123",
  "notes": "xyz789",
  "instructions": "xyz789",
  "confirmationCode": "xyz789",
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "addresses": [TrackingDetailAddress],
  "warehouseId": 987,
  "scheduledAtInUtc": "2007-12-03",
  "customerCloseTimeInUtc": "2007-12-03"
}

Types

TrackingDetailAddress

Fields

Field Name	Description
`id` - `Int`
`trackingDetailId` - `Int`
`name` - `String`
`street1` - `String`
`street2` - `String`
`city` - `String`
`state` - `String`
`zipcode` - `String`
`country` - `String`
`residential` - `Boolean`
`type` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 987,
  "trackingDetailId": 123,
  "name": "abc123",
  "street1": "xyz789",
  "street2": "abc123",
  "city": "abc123",
  "state": "xyz789",
  "zipcode": "abc123",
  "country": "xyz789",
  "residential": true,
  "type": 123,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

TrackingDetailStatistics

Fields

Field Name	Description
`dropOff` - `Int`
`pickUp` - `Int`
`returnToUser` - `Int`

Example

{"dropOff": 987, "pickUp": 123, "returnToUser": 987}

Types

UnarchiveWarehouseParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 123}

Types

UnlockBoxParams

Fields

Input Field	Description
`id` - `Int!`

Example

{"id": 987}

Types

UnlockBoxResponse

Fields

Field Name	Description
`box` - `Box!`

Example

{"box": Box}

Types

UpdateAdminUserParams

Fields

Input Field	Description
`id` - `Int!`
`firstName` - `String`
`lastName` - `String`
`email` - `String`
`phone` - `String`	(Deprecated) Phone number is not used to update an admin user anymore
`roles` - `[String]`
`warehouseId` - `Int`

Example

{
  "id": 123,
  "firstName": "abc123",
  "lastName": "abc123",
  "email": "abc123",
  "phone": "abc123",
  "roles": ["xyz789"],
  "warehouseId": 987
}

Types

UpdateAdminUserResponse

Fields

Field Name	Description
`admin` - `Admin!`

Example

{"admin": Admin}

Types

UpdateApiKeyParams

Fields

Input Field	Description
`id` - `Int!`
`name` - `String!`
`roles` - `[String!]!`
`expiresIn` - `String!`

Example

{
  "id": 123,
  "name": "abc123",
  "roles": ["xyz789"],
  "expiresIn": "abc123"
}

Types

UpdateApiKeyResponse

Fields

Field Name	Description
`apiKey` - `ApiKey!`

Example

{"apiKey": ApiKey}

Types

UpdateBoxLocationParams

Fields

Input Field	Description
`id` - `Int!`
`warehouseSpotIdentifier` - `String!`

Example

{
  "id": 123,
  "warehouseSpotIdentifier": "abc123"
}

Types

UpdateBoxLocationResponse

Fields

Field Name	Description
`box` - `Box!`

Example

{"box": Box}

Types

UpdateBoxParams

Fields

Input Field	Description
`id` - `Int!`
`title` - `String`
`description` - `String`
`thumbnail` - `String`

Example

{
  "id": 123,
  "title": "xyz789",
  "description": "xyz789",
  "thumbnail": "xyz789"
}

Types

UpdateBoxResponse

Fields

Field Name	Description
`box` - `Box!`

Example

{"box": Box}

Types

UpdateBoxTypeParams

Fields

Input Field	Description
`id` - `Int!`
`name` - `String`
`maxHeight` - `Float`
`maxWidth` - `Float`
`maxLength` - `Float`
`maxWeight` - `Float`

Example

{
  "id": 123,
  "name": "xyz789",
  "maxHeight": 987.65,
  "maxWidth": 123.45,
  "maxLength": 123.45,
  "maxWeight": 123.45
}

Types

UpdateBoxTypeResponse

Fields

Field Name	Description
`boxType` - `BoxType!`

Example

{"boxType": BoxType}

Types

UpdateConfigurableParameterParams

Fields

Input Field	Description
`id` - `Int!`
`key` - `String`
`value` - `String`
`type` - `Int`

Example

{
  "id": 123,
  "key": "abc123",
  "value": "xyz789",
  "type": 123
}

Types

UpdateConfigurableParameterResponse

Fields

Field Name	Description
`configurableParameter` - `ConfigurableParameter!`

Example

{"configurableParameter": ConfigurableParameter}

Types

UpdateCustomerAddressParams

Fields

Input Field	Description
`id` - `Int!`
`customerName` - `String`
`title` - `String`
`street1` - `String`
`street2` - `String`
`city` - `String`
`state` - `String`
`zipcode` - `String`
`country` - `String`
`residential` - `Boolean`
`defaultBilling` - `Boolean`
`defaultShipping` - `Boolean`
`instructions` - `String`
`latitude` - `Float`
`longitude` - `Float`

Example

{
  "id": 987,
  "customerName": "abc123",
  "title": "abc123",
  "street1": "xyz789",
  "street2": "abc123",
  "city": "xyz789",
  "state": "abc123",
  "zipcode": "abc123",
  "country": "abc123",
  "residential": false,
  "defaultBilling": false,
  "defaultShipping": false,
  "instructions": "abc123",
  "latitude": 987.65,
  "longitude": 987.65
}

Types

UpdateCustomerAddressResponse

Fields

Field Name	Description
`address` - `CustomerAddress!`

Example

{"address": CustomerAddress}

Types

UpdateCustomerGroupParams

Fields

Input Field	Description
`id` - `Int!`
`name` - `String`
`description` - `String`
`status` - `CustomerGroupStatus`
`paymentMethodRequired` - `Boolean`
`purchaseFeeDiscountType` - `CustomerGroupDiscountType`
`purchaseFeeDiscountAmount` - `Int`
`storageFeeDiscountType` - `CustomerGroupDiscountType`
`storageFeeDiscountAmount` - `Int`
`excessWeightFeeDiscountType` - `CustomerGroupDiscountType`
`excessWeightFeeDiscountAmount` - `Int`
`returnToUserFeeDiscountType` - `CustomerGroupDiscountType`
`returnToUserFeeDiscountAmount` - `Int`

Example

{
  "id": 123,
  "name": "abc123",
  "description": "xyz789",
  "status": "INACTIVE",
  "paymentMethodRequired": false,
  "purchaseFeeDiscountType": "PERCENTAGE",
  "purchaseFeeDiscountAmount": 987,
  "storageFeeDiscountType": "PERCENTAGE",
  "storageFeeDiscountAmount": 123,
  "excessWeightFeeDiscountType": "PERCENTAGE",
  "excessWeightFeeDiscountAmount": 123,
  "returnToUserFeeDiscountType": "PERCENTAGE",
  "returnToUserFeeDiscountAmount": 123
}

Types

UpdateCustomerGroupResponse

Fields

Field Name	Description
`customerGroup` - `CustomerGroup!`

Example

{"customerGroup": CustomerGroup}

Types

UpdateCustomerParams

Fields

Input Field	Description
`id` - `Int!`
`firstName` - `String`
`lastName` - `String`
`email` - `String`
`phone` - `String`
`status` - `Int`
`pushNotificationsRelatedToBoxes` - `Boolean`
`emailNotificationsRelatedToBoxes` - `Boolean`
`smsNotificationsRelatedToBoxes` - `Boolean`
`inAppNotificationsRelatedToBoxes` - `Boolean`
`pushNotificationsRelatedToChat` - `Boolean`
`emailNotificationsRelatedToChat` - `Boolean`
`smsNotificationsRelatedToChat` - `Boolean`
`inAppNotificationsRelatedToChat` - `Boolean`
`pushNotificationsRelatedToProductAnnouncements` - `Boolean`
`emailNotificationsRelatedToProductAnnouncements` - `Boolean`
`smsNotificationsRelatedToProductAnnouncements` - `Boolean`
`inAppNotificationsRelatedToProductAnnouncements` - `Boolean`

Example

{
  "id": 123,
  "firstName": "abc123",
  "lastName": "abc123",
  "email": "abc123",
  "phone": "abc123",
  "status": 987,
  "pushNotificationsRelatedToBoxes": false,
  "emailNotificationsRelatedToBoxes": false,
  "smsNotificationsRelatedToBoxes": true,
  "inAppNotificationsRelatedToBoxes": true,
  "pushNotificationsRelatedToChat": true,
  "emailNotificationsRelatedToChat": true,
  "smsNotificationsRelatedToChat": false,
  "inAppNotificationsRelatedToChat": true,
  "pushNotificationsRelatedToProductAnnouncements": false,
  "emailNotificationsRelatedToProductAnnouncements": false,
  "smsNotificationsRelatedToProductAnnouncements": false,
  "inAppNotificationsRelatedToProductAnnouncements": true
}

Types

UpdateCustomerResponse

Fields

Field Name	Description
`customer` - `Customer!`

Example

{"customer": Customer}

Types

UpdateDiscountCouponParams

Fields

Input Field	Description
`id` - `Int!`
`type` - `DiscountCouponType`
`amount` - `Float`	Discount amount in cents or percentage value
`limit` - `Int`
`status` - `DiscountCouponStatus`
`minimumPurchaseAmount` - `Int`	Minimum purchase amount in cents
`maximumPurchaseAmount` - `Int`	Maximum purchase amount in cents
`startDate` - `String`
`endDate` - `String`
`isUnlimited` - `Boolean`
`minimumBoxesAmount` - `Int`	Minimum boxes amount
`applyToRecurrentPayments` - `Boolean`	Apply to recurrent payments
`firstPurchaseOnly` - `Boolean`	Apply only to a customer first purchase
`usageLimitPerCustomer` - `Int`	Maximum number of times a customer can use this coupon
`recurringBillingCyclesLimit` - `Int`	Number of billing cycles to apply recurring discount (includes initial purchase, 0 = unlimited)

Example

{
  "id": 123,
  "type": "PERCENTAGE",
  "amount": 987.65,
  "limit": 987,
  "status": "ACTIVE",
  "minimumPurchaseAmount": 987,
  "maximumPurchaseAmount": 123,
  "startDate": "xyz789",
  "endDate": "xyz789",
  "isUnlimited": false,
  "minimumBoxesAmount": 123,
  "applyToRecurrentPayments": false,
  "firstPurchaseOnly": true,
  "usageLimitPerCustomer": 987,
  "recurringBillingCyclesLimit": 123
}

Types

UpdateNoteParams

Fields

Input Field	Description
`id` - `Int!`
`content` - `String!`

Example

{"id": 123, "content": "xyz789"}

Types

UpdateNoteResponse

Fields

Field Name	Description
`note` - `Note!`

Example

{"note": Note}

Types

UpdateOrderShippingAddressParams

Fields

Input Field	Description
`orderId` - `Int!`
`shippingAddress` - `UpdateShippingAddressParams!`

Example

{
  "orderId": 987,
  "shippingAddress": UpdateShippingAddressParams
}

Types

UpdateOrderShippingAddressResponse

Fields

Field Name	Description
`order` - `Order!`

Example

{"order": Order}

Types

UpdateOrderShippingDetailParams

Fields

Input Field	Description
`orderId` - `Int!`
`orderShippingDetailId` - `Int!`
`trackingNumber` - `String`

Example

{
  "orderId": 987,
  "orderShippingDetailId": 987,
  "trackingNumber": "xyz789"
}

Types

UpdateProductParams

Fields

Input Field	Description
`id` - `Int!`
`sku` - `String`
`status` - `Int`
`title` - `String`
`description` - `String`
`shortDescription` - `String`
`urlKey` - `String`
`seoTitle` - `String`
`seoDescription` - `String`
`seoKeywords` - `String`
`boxTypeId` - `Int`
`quantity` - `Int`
`boxQuantity` - `Int`	This field will be set internally
`type` - `ProductType`	(Deprecated) This field is deprecated and will be removed in future versions. It is not possible to change product type after creation
`isMostPopular` - `Boolean`
`isStarterKit` - `Boolean`
`prices` - `[ProductPriceUpdate]`
`images` - `[ProductImageUpdateParams]`

Example

{
  "id": 987,
  "sku": "xyz789",
  "status": 987,
  "title": "abc123",
  "description": "abc123",
  "shortDescription": "xyz789",
  "urlKey": "xyz789",
  "seoTitle": "abc123",
  "seoDescription": "xyz789",
  "seoKeywords": "xyz789",
  "boxTypeId": 987,
  "quantity": 123,
  "boxQuantity": 123,
  "type": "BOX",
  "isMostPopular": true,
  "isStarterKit": false,
  "prices": [ProductPriceUpdate],
  "images": [ProductImageUpdateParams]
}

Types

UpdateProductPriceParams

Fields

Input Field	Description
`changes` - `ProductPriceUpdate!`

Example

{"changes": ProductPriceUpdate}

Types

UpdateProductResponse

Fields

Field Name	Description
`product` - `Product!`

Example

{"product": Product}

Types

UpdateProductsParams

Fields

Input Field	Description
`id` - `Int!`
`sku` - `String`
`status` - `Int`
`title` - `String`
`description` - `String`
`shortDescription` - `String`
`urlKey` - `String`
`seoTitle` - `String`
`seoDescription` - `String`
`seoKeywords` - `String`
`boxTypeId` - `Int`
`quantity` - `Int`
`boxQuantity` - `Int`	This field will be set internally
`type` - `ProductType`	(Deprecated) This field is deprecated and will be removed in future versions. It is not possible to change product type after creation
`isMostPopular` - `Boolean`
`isStarterKit` - `Boolean`
`prices` - `[ProductPriceUpdate]`
`images` - `[ProductImageUpdateParams]`

Example

{
  "id": 987,
  "sku": "abc123",
  "status": 123,
  "title": "xyz789",
  "description": "abc123",
  "shortDescription": "xyz789",
  "urlKey": "abc123",
  "seoTitle": "xyz789",
  "seoDescription": "abc123",
  "seoKeywords": "abc123",
  "boxTypeId": 987,
  "quantity": 987,
  "boxQuantity": 123,
  "type": "BOX",
  "isMostPopular": true,
  "isStarterKit": true,
  "prices": [ProductPriceUpdate],
  "images": [ProductImageUpdateParams]
}

Types

UpdateShippingAddressParams

Fields

Input Field	Description
`customerName` - `String`
`street1` - `String`
`street2` - `String`
`city` - `String`
`state` - `String`
`zipcode` - `String`
`country` - `String`
`residential` - `Boolean`
`instructions` - `String`

Example

{
  "customerName": "abc123",
  "street1": "abc123",
  "street2": "xyz789",
  "city": "abc123",
  "state": "abc123",
  "zipcode": "abc123",
  "country": "xyz789",
  "residential": false,
  "instructions": "abc123"
}

Types

UpdateShoppingCartLineItemQuantityWithLineItemIdParams

Fields

Input Field	Description
`lineItemId` - `Int!`
`quantity` - `Int!`

Example

{"lineItemId": 987, "quantity": 987}

Types

UpdateShoppingCartLineItemQuantityWithProductIdParams

Fields

Input Field	Description
`productId` - `Int!`
`quantity` - `Int!`

Example

{"productId": 123, "quantity": 987}

Types

UpdateShoppingCartLineItemsQuantityParams

Fields

Input Field	Description
`externalId` - `String`
`cartId` - `Int`	(Deprecated) Use externalId instead of cartId
`type` - `UpdateShoppingCartLineItemsQuantityType!`
`itemsWithProductId` - `[UpdateShoppingCartLineItemQuantityWithProductIdParams!]`
`itemsWithLineItemId` - `[UpdateShoppingCartLineItemQuantityWithLineItemIdParams!]`

Example

{
  "externalId": "abc123",
  "cartId": 987,
  "type": "PRODUCT_ID",
  "itemsWithProductId": [
    UpdateShoppingCartLineItemQuantityWithProductIdParams
  ],
  "itemsWithLineItemId": [
    UpdateShoppingCartLineItemQuantityWithLineItemIdParams
  ]
}

Types

UpdateShoppingCartLineItemsQuantityType

Values

Enum Value	Description
`PRODUCT_ID`
`LINE_ITEM_ID`

Example

"PRODUCT_ID"

Types

UpdateTrackingDetailParams

Fields

Input Field	Description
`trackingDetailId` - `Int!`
`trackingNumber` - `String`
`confirmationCode` - `String`

Example

{
  "trackingDetailId": 987,
  "trackingNumber": "abc123",
  "confirmationCode": "abc123"
}

Types

UpdateWarehouseParams

Fields

Input Field	Description
`id` - `Int!`
`name` - `String`
`shipperName` - `String`
`telephone` - `String`
`street1` - `String`
`street2` - `String`
`city` - `String`
`state` - `String`
`zipcode` - `String`
`country` - `String`

Example

{
  "id": 123,
  "name": "abc123",
  "shipperName": "xyz789",
  "telephone": "xyz789",
  "street1": "xyz789",
  "street2": "abc123",
  "city": "abc123",
  "state": "xyz789",
  "zipcode": "abc123",
  "country": "xyz789"
}

Types

UpdateWarehouseResponse

Fields

Field Name	Description
`warehouse` - `Warehouse!`

Example

{"warehouse": Warehouse}

Types

UpdateWarehouseSpotParams

Fields

Input Field	Description
`id` - `Int!`
`warehouseId` - `Int!`
`spotIdentifier` - `String`
`spotLocation` - `String`
`zone` - `String`
`location` - `String`
`notes` - `String`
`maxWeight` - `Float`
`maxWidth` - `Float`
`maxHeight` - `Float`
`maxLength` - `Float`
`type` - `Int`

Example

{
  "id": 123,
  "warehouseId": 123,
  "spotIdentifier": "abc123",
  "spotLocation": "xyz789",
  "zone": "abc123",
  "location": "xyz789",
  "notes": "abc123",
  "maxWeight": 987.65,
  "maxWidth": 123.45,
  "maxHeight": 987.65,
  "maxLength": 123.45,
  "type": 123
}

Types

UpdateWarehouseSpotResponse

Fields

Field Name	Description
`warehouseSpot` - `WarehouseSpot!`

Example

{"warehouseSpot": WarehouseSpot}

Types

Warehouse

Fields

Field Name	Description
`id` - `Int`
`status` - `Int`
`name` - `String`
`shipperName` - `String`
`telephone` - `String`
`street1` - `String`
`street2` - `String`
`city` - `String`
`state` - `String`
`zipcode` - `String`
`country` - `String`
`createdAt` - `Date`
`updatedAt` - `Date`

Example

{
  "id": 123,
  "status": 987,
  "name": "abc123",
  "shipperName": "abc123",
  "telephone": "abc123",
  "street1": "abc123",
  "street2": "xyz789",
  "city": "abc123",
  "state": "abc123",
  "zipcode": "xyz789",
  "country": "abc123",
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03"
}

Types

WarehouseSpot

Fields

Field Name	Description
`id` - `Int`
`spotIdentifier` - `String`
`spotLocation` - `String`
`zone` - `String`
`location` - `String`
`notes` - `String`
`maxWeight` - `Float`
`maxWidth` - `Float`
`maxHeight` - `Float`
`maxLength` - `Float`
`warehouseId` - `Int`
`type` - `Int`
`status` - `Int`
`createdAt` - `Date`
`updatedAt` - `Date`
`totalBoxes` - `Int`

Example

{
  "id": 123,
  "spotIdentifier": "abc123",
  "spotLocation": "abc123",
  "zone": "xyz789",
  "location": "abc123",
  "notes": "xyz789",
  "maxWeight": 987.65,
  "maxWidth": 123.45,
  "maxHeight": 987.65,
  "maxLength": 987.65,
  "warehouseId": 987,
  "type": 123,
  "status": 987,
  "createdAt": "2007-12-03",
  "updatedAt": "2007-12-03",
  "totalBoxes": 987
}

Documentation by Anvil SpectaQL