AlmondTill/G3N API

Switch shared catalog entries on for your organization

Brands, seasons, manufacturers, styles and divisions are shared across the group; switching one on locally is how your organization starts using it — and decorations add the display content a record shows.

Catalog · a play in 4 steps.

The steps

  1. Switch a shared brand on for your organization. — createOrgBrand
  2. Switch a shared season, manufacturer or division on. — createOrgSeason, createOrgManufacturer, createOrgDivision
  3. Sell a shared style locally by switching it on. — createOrgStyle
  4. Attach display content — images, blurbs — to a record. — createDecoration

The calls

Every operation this use case runs, in the order it first appears, with the request and the response its reference page shows.

createOrgBrand

createOrgBrand — mutation · Create a new your organization’s enablement of a shared brand — switching it on locally at your organization.

Example request

mutation ExampleCreateOrgBrand($input: NewOrgBrandInput!) {
  createOrgBrand(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    brandId
    code
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "organizationId": "01900000-0000-7000-8000-44b781470000",
    "brandId": "01900000-0000-7000-8000-4067736b0000"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createOrgBrand": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "EB-EXMP-0000-000F",
      "type": "OrgBrand",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "brandId": "01900000-0000-7000-8000-4067736b0000",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

createOrgSeason

createOrgSeason — mutation · Create a new your organization’s enablement of a shared season at your organization.

Example request

mutation ExampleCreateOrgSeason($input: NewOrgSeasonInput!) {
  createOrgSeason(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    seasonId
    code
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "organizationId": "01900000-0000-7000-8000-44b781470000",
    "seasonId": "01900000-0000-7000-8000-45de25e50000"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createOrgSeason": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "ES-EXMP-0000-000F",
      "type": "OrgSeason",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "seasonId": "01900000-0000-7000-8000-45de25e50000",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

createOrgManufacturer

createOrgManufacturer — mutation · Create a new your organization’s enablement of a shared manufacturer at your organization.

Example request

mutation ExampleCreateOrgManufacturer($input: NewOrgManufacturerInput!) {
  createOrgManufacturer(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    manufacturerId
    code
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "organizationId": "01900000-0000-7000-8000-44b781470000",
    "manufacturerId": "01900000-0000-7000-8000-7cefed4d0000"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createOrgManufacturer": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "EM-EXMP-0000-000F",
      "type": "OrgManufacturer",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "manufacturerId": "01900000-0000-7000-8000-7cefed4d0000",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

createOrgDivision

createOrgDivision — mutation · Create a new your organization’s enablement of a shared division at your organization.

Example request

mutation ExampleCreateOrgDivision($input: NewOrgDivisionInput!) {
  createOrgDivision(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    divisionId
    code
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "organizationId": "01900000-0000-7000-8000-44b781470000",
    "divisionId": "01900000-0000-7000-8000-25bd925b0000"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createOrgDivision": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "ED-EXMP-0000-000F",
      "type": "OrgDivision",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "divisionId": "01900000-0000-7000-8000-25bd925b0000",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

createOrgStyle

createOrgStyle — mutation · Create a new your organization’s enablement of a shared style — selling it locally at your organization.

Example request

mutation ExampleCreateOrgStyle($input: NewOrgStyleInput!) {
  createOrgStyle(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    styleId
    code
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "organizationId": "01900000-0000-7000-8000-44b781470000",
    "styleId": "01900000-0000-7000-8000-2f797c8b0000"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createOrgStyle": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "EY-EXMP-0000-000F",
      "type": "OrgStyle",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "styleId": "01900000-0000-7000-8000-2f797c8b0000",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

createDecoration

createDecoration — mutation · Create a new decoration — extra display content attached to a record (images, blurbs) at your organization.

Example request

mutation ExampleCreateDecoration($input: NewDecorationInput!) {
  createDecoration(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    purpose
    locale
    ordinal
    text
    attachedToType
    attachedToId
    code
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "purpose": "<purpose>",
    "locale": "en-CA",
    "text": "Restock before the weekend.",
    "attachedToType": "Brand",
    "attachedToId": "01900000-0000-7000-8000-e744ae790000"
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createDecoration": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "DC-EXMP-0000-000F",
      "type": "Decoration",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "purpose": "<purpose>",
      "locale": "en-CA",
      "ordinal": 1,
      "text": "Restock before the weekend.",
      "attachedToType": "Brand",
      "attachedToId": "01900000-0000-7000-8000-e744ae790000",
      "code": "BJ-001"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}