Mutations

CreateCustomer

Create a customer (if you are allowed to create customers)

Parameters

input - CustomerInput
Data of the customer

Example

GraphQL

mutation {
    CreateCustomer (
        input: {
            label: "Bob Dylan",
            first_name: "Bob",
            last_name: "Dylan",
            email: "[email protected]"
        }
    ){
        id
        active
    }
}

Returned data

JSON

{
  "data": {
    "CreateCustomer": {
      "id": 101122,
      "active": true
    }
  }
}

UpdateCustomer

Update a customer

Parameters

id - ID
Id of the customer to update

input - CustomerInput
Data of the customer

Example

GraphQL

mutation UpdateCustomer($id: ID!, $input: CustomerInput!) {
  UpdateCustomer(id: $id, input: $input) {
    id
    label
    first_name
    last_name
    email
  }
}

Variables (JSON)

{
  "id": 100005,
  "input": {
    "id": 100005,
    "label": "Hoppe",
    "first_name": "Palma",
    "last_name": "Heaney",
    "email": "[email protected]"
  }
}

Returned data

JSON

{
  "data": {
    "UpdateCustomer": {
      "id": 100005,
      "label": "Hoppe",
      "first_name": "Palma",
      "last_name": "Heaney",
      "email": "[email protected]"
    }
  }
}

DeleteCustomer

Delete a customer

Parameters

id - ID
Id of the customer

Example

GraphQL

mutation DeleteCustomer($id: ID!) {
  DeleteCustomer(id: $id)
}

Variables (JSON)

{
  "id": 100009
}

Returned data

JSON

{
  "data": {
    "DeleteCustomer": true
  }
}

DisableCustomer

Disable a customer

Parameters

id - ID
Id of the customer

Example

GraphQL

mutation DisableCustomer($id: ID!) {
  DisableCustomer(id: $id) {
    id
    active
  }
}

Variables (JSON)

{
  "id": 100011
}

Returned data

JSON

{
  "data": {
    "DisableCustomer": {
      "id": 100011,
      "active": false
    }
  }
}

EnableCustomer

Enable a disabled customer

Parameters

id - ID
Id of the customer

Example

GraphQL

mutation EnableCustomer($id: ID!) {
  EnableCustomer(id: $id) {
    id
    active
  }
}

JSON

{
  "id": 100009
}

Returned data

JSON

{
  "data": {
    "EnableCustomer": {
      "id": 100011,
      "active": true
    }
  }
}

CustomerInput data type

label - String
Full name of the customer

first_name - String
First name of the customer

last_name - String
Last name of the customer

email - String
Email of the customer

Address - AddressInput
Address of the customer