Sanbuyos GraphQL API Reference

Welcome to Sanbuyos API Documentation!

Contact

API Support

API Endpoints

# Production:
https://api.sanbuyos.com/query

Headers

# Authentication
Authorization: <YOUR_TOKEN_HERE>

Queries

`branchItemChildren`

Response

Returns [BranchItemChild!]!

Arguments

Name	Description
`filters` - `[BranchItemChildFilterInput!]!`

Example

Query

query branchItemChildren($filters: [BranchItemChildFilterInput!]!) {
  branchItemChildren(filters: $filters) {
    id
    branch {
      ...BranchFragment
    }
    itemChild {
      ...ItemChildFragment
    }
    quantity
    isActive
  }
}

Variables

{"filters": [BranchItemChildFilterInput]}

Response

{
  "data": {
    "branchItemChildren": [
      {
        "id": "abc123",
        "branch": Branch,
        "itemChild": ItemChild,
        "quantity": 42,
        "isActive": true
      }
    ]
  }
}

Queries

`itemChildOffers`

Response

Returns [ItemChildOffer!]!

Arguments

Name	Description
`filters` - `[ItemChildOfferFilterInput!]!`
`search` - `String`
`pagination` - `PaginationInput`	Default = `{page: 1, size: 100}`

Example

Query

query itemChildOffers(
  $filters: [ItemChildOfferFilterInput!]!,
  $search: String,
  $pagination: PaginationInput
) {
  itemChildOffers(
    filters: $filters,
    search: $search,
    pagination: $pagination
  ) {
    id
    itemChild {
      ...ItemChildFragment
    }
    code
    barcode
    isActive
  }
}

Variables

{
  "filters": [ItemChildOfferFilterInput],
  "search": "Generated Argument example for itemChildOffers search",
  "pagination": {"page": 1, "size": 100}
}

Response

{
  "data": {
    "itemChildOffers": [
      {
        "id": "abc123",
        "itemChild": ItemChild,
        "code": "abc123",
        "barcode": "xyz789",
        "isActive": true
      }
    ]
  }
}

Queries

`orderBranches`

Response

Returns [OrderBranch!]!

Arguments

Name	Description
`filters` - `[OrderBranchFilterInput!]!`
`search` - `String`
`pagination` - `PaginationInput`	Default = `{page: 1, size: 100}`

Example

Query

query orderBranches(
  $filters: [OrderBranchFilterInput!]!,
  $search: String,
  $pagination: PaginationInput
) {
  orderBranches(
    filters: $filters,
    search: $search,
    pagination: $pagination
  ) {
    id
    sancode
    currency {
      ...CurrencyFragment
    }
    supplierCurrency {
      ...CurrencyFragment
    }
    supplierAccount {
      ...AccountFragment
    }
    supplierSenderBranch {
      ...BranchFragment
    }
    customerAccount {
      ...AccountFragment
    }
    customerBranch {
      ...BranchFragment
    }
    customerReceiverBranch {
      ...BranchFragment
    }
    isWholesale
    isActive
    updatedAt
    createdAt
    orderBranchItemChildren {
      ...OrderBranchItemChildFragment
    }
    packages {
      ...PackageFragment
    }
  }
}

Variables

{
  "filters": [OrderBranchFilterInput],
  "search": "Generated Argument example for orderBranches search",
  "pagination": {"page": 1, "size": 100}
}

Response

{
  "data": {
    "orderBranches": [
      {
        "id": "xyz789",
        "sancode": "abc123",
        "currency": Currency,
        "supplierCurrency": Currency,
        "supplierAccount": Account,
        "supplierSenderBranch": Branch,
        "customerAccount": Account,
        "customerBranch": Branch,
        "customerReceiverBranch": Branch,
        "isWholesale": false,
        "isActive": false,
        "updatedAt": "abc123",
        "createdAt": "xyz789",
        "orderBranchItemChildren": [OrderBranchItemChild],
        "packages": [Package]
      }
    ]
  }
}

Queries

`orderBranchesInfo`

Response

Returns an Info!

Arguments

Name	Description
`filters` - `[OrderBranchFilterInput!]!`
`search` - `String`

Example

Query

query orderBranchesInfo(
  $filters: [OrderBranchFilterInput!]!,
  $search: String
) {
  orderBranchesInfo(
    filters: $filters,
    search: $search
  ) {
    count
  }
}

Variables

{
  "filters": [OrderBranchFilterInput],
  "search": "Generated Argument example for orderBranchesInfo search"
}

Response

{"data": {"orderBranchesInfo": {"count": 42}}}

Mutations

`createDefaultPackages`

Description

Use this method to create default order packages for order branches.

Response

Returns [Package!]!

Arguments

Name	Description
`input` - `[OrderBranchInput!]!`

Example

Query

mutation createDefaultPackages($input: [OrderBranchInput!]!) {
  createDefaultPackages(input: $input) {
    id
    orderBranch {
      ...OrderBranchFragment
    }
    invoice {
      ...InvoiceFragment
    }
    sancode
    shippedAt
    readyToShipAt
    closedAt
    progressStartedAt
    departedAt
    outForDeliveryAt
    deliveredAt
    labelFile {
      ...FileFragment
    }
    isActive
    updatedAt
    createdAt
    packageItemChildren {
      ...PackageItemChildFragment
    }
  }
}

Variables

{"input": [OrderBranchInput]}

Response

{
  "data": {
    "createDefaultPackages": [
      {
        "id": "xyz789",
        "orderBranch": OrderBranch,
        "invoice": Invoice,
        "sancode": "xyz789",
        "shippedAt": "abc123",
        "readyToShipAt": "abc123",
        "closedAt": "abc123",
        "progressStartedAt": "abc123",
        "departedAt": "xyz789",
        "outForDeliveryAt": "xyz789",
        "deliveredAt": "abc123",
        "labelFile": File,
        "isActive": true,
        "updatedAt": "xyz789",
        "createdAt": "abc123",
        "packageItemChildren": [PackageItemChild]
      }
    ]
  }
}

Mutations

`createOrUpdateBranchItemChildren`

Description

Use this method to update quantity of branch item child.

Response

Returns [BranchItemChild!]!

Arguments

Name	Description
`input` - `[BranchItemChildInput!]!`

Example

Query

mutation createOrUpdateBranchItemChildren($input: [BranchItemChildInput!]!) {
  createOrUpdateBranchItemChildren(input: $input) {
    id
    branch {
      ...BranchFragment
    }
    itemChild {
      ...ItemChildFragment
    }
    quantity
    isActive
  }
}

Variables

{"input": [BranchItemChildInput]}

Response

{
  "data": {
    "createOrUpdateBranchItemChildren": [
      {
        "id": "xyz789",
        "branch": Branch,
        "itemChild": ItemChild,
        "quantity": 42,
        "isActive": true
      }
    ]
  }
}

Mutations

`login`

Description

Use this method to get your Authorization token. Please pay attention to the token lifetime to avoid problems.

Response

Returns a LoginOutput!

Arguments

Name	Description
`input` - `LoginInput!`

Example

Query

mutation login($input: LoginInput!) {
  login(input: $input) {
    token
    expiryTime
  }
}

Variables

{"input": LoginInput}

Response

{
  "data": {
    "login": {
      "token": "xyz789",
      "expiryTime": 123.45
    }
  }
}

Mutations

`updateOrderBranchItemChildren`

Description

Use this method to approve or reject the order item child. Changes cannot be made after the update.

Response

Returns [OrderBranchItemChild!]!

Arguments

Name	Description
`input` - `[OrderBranchItemChildInput!]!`

Example

Query

mutation updateOrderBranchItemChildren($input: [OrderBranchItemChildInput!]!) {
  updateOrderBranchItemChildren(input: $input) {
    id
    orderBranch {
      ...OrderBranchFragment
    }
    itemChild {
      ...ItemChildFragment
    }
    currentQuantity
    quantity
    amount
    shippingCost
    discount
    installmentCost
    supplierAmount
    supplierShippingCost
    isApproved
    invoicedQuantity
    packedQuantity
    cancelledQuantity
    readyToShipQuantity
    shippedQuantity
    externalShippedQuantity
    orderBranchItemChildStatus {
      ...OrderBranchItemChildStatusFragment
    }
    isActive
  }
}

Variables

{"input": [OrderBranchItemChildInput]}

Response

{
  "data": {
    "updateOrderBranchItemChildren": [
      {
        "id": "xyz789",
        "orderBranch": OrderBranch,
        "itemChild": ItemChild,
        "currentQuantity": 42,
        "quantity": 42,
        "amount": 123.45,
        "shippingCost": 123.45,
        "discount": 987.65,
        "installmentCost": 987.65,
        "supplierAmount": 123.45,
        "supplierShippingCost": 123.45,
        "isApproved": false,
        "invoicedQuantity": 42,
        "packedQuantity": 42,
        "cancelledQuantity": 42,
        "readyToShipQuantity": 42,
        "shippedQuantity": 42,
        "externalShippedQuantity": 42,
        "orderBranchItemChildStatus": OrderBranchItemChildStatus,
        "isActive": false
      }
    ]
  }
}

Mutations

`updatePackages`

Description

Use this method to report the ready to ship status and shipped status of the order package.

Response

Returns [Package!]!

Arguments

Name	Description
`input` - `[PackageInput!]!`

Example

Query

mutation updatePackages($input: [PackageInput!]!) {
  updatePackages(input: $input) {
    id
    orderBranch {
      ...OrderBranchFragment
    }
    invoice {
      ...InvoiceFragment
    }
    sancode
    shippedAt
    readyToShipAt
    closedAt
    progressStartedAt
    departedAt
    outForDeliveryAt
    deliveredAt
    labelFile {
      ...FileFragment
    }
    isActive
    updatedAt
    createdAt
    packageItemChildren {
      ...PackageItemChildFragment
    }
  }
}

Variables

{"input": [PackageInput]}

Response

{
  "data": {
    "updatePackages": [
      {
        "id": "abc123",
        "orderBranch": OrderBranch,
        "invoice": Invoice,
        "sancode": "xyz789",
        "shippedAt": "abc123",
        "readyToShipAt": "abc123",
        "closedAt": "abc123",
        "progressStartedAt": "xyz789",
        "departedAt": "xyz789",
        "outForDeliveryAt": "abc123",
        "deliveredAt": "abc123",
        "labelFile": File,
        "isActive": true,
        "updatedAt": "xyz789",
        "createdAt": "abc123",
        "packageItemChildren": [PackageItemChild]
      }
    ]
  }
}

Types

Account

Fields

Field Name	Description
`id` - `String!`
`fullName` - `String!`
`isActive` - `Boolean!`

Example

{
  "id": "xyz789",
  "fullName": "xyz789",
  "isActive": true
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

BooleanFilterInput

Fields

Input Field	Description
`equalIsActive` - `Boolean`
`equal` - `Boolean`
`notEqualIsActive` - `Boolean`
`notEqual` - `Boolean`

Example

{
  "equalIsActive": true,
  "equal": false,
  "notEqualIsActive": true,
  "notEqual": false
}

Types

Branch

Fields

Field Name	Description
`id` - `String!`
`name` - `String!`
`country` - `Country`
`province` - `Province`
`city` - `City`
`postalCode` - `PostalCode`
`isCorporate` - `Boolean`
`identityCode` - `String`
`identityCodeIsValid` - `Boolean`
`taxCode` - `String`
`taxCodeIsValid` - `Boolean`
`taxOffice` - `String`
`fullName` - `String`
`address` - `String`
`email` - `String`
`phoneNumber` - `String`
`dispatchTime` - `Int`
`isActive` - `Boolean`

Example

{
  "id": "abc123",
  "name": "xyz789",
  "country": Country,
  "province": Province,
  "city": City,
  "postalCode": PostalCode,
  "isCorporate": false,
  "identityCode": "xyz789",
  "identityCodeIsValid": true,
  "taxCode": "xyz789",
  "taxCodeIsValid": true,
  "taxOffice": "xyz789",
  "fullName": "abc123",
  "address": "abc123",
  "email": "abc123",
  "phoneNumber": "xyz789",
  "dispatchTime": 42,
  "isActive": false
}

Types

BranchInput

Fields

Input Field	Description
`id` - `String`
`name` - `String`
`country` - `CountryInput`
`province` - `ProvinceInput`
`city` - `CityInput`
`postalCode` - `PostalCodeInput`
`isCorporate` - `Boolean`
`identityCode` - `String`
`identityCodeIsValid` - `Boolean`
`taxCode` - `String`
`taxCodeIsValid` - `Boolean`
`taxOffice` - `String`
`fullName` - `String`
`address` - `String`
`email` - `String`
`phoneNumber` - `String`
`dispatchTime` - `Int`
`isActive` - `Boolean`

Example

{
  "id": "xyz789",
  "name": "abc123",
  "country": CountryInput,
  "province": ProvinceInput,
  "city": CityInput,
  "postalCode": PostalCodeInput,
  "isCorporate": true,
  "identityCode": "xyz789",
  "identityCodeIsValid": true,
  "taxCode": "abc123",
  "taxCodeIsValid": true,
  "taxOffice": "abc123",
  "fullName": "abc123",
  "address": "abc123",
  "email": "xyz789",
  "phoneNumber": "abc123",
  "dispatchTime": 42,
  "isActive": false
}

Types

BranchItemChild

Fields

Field Name	Description
`id` - `String`
`branch` - `Branch`
`itemChild` - `ItemChild`
`quantity` - `Int`
`isActive` - `Boolean`

Example

{
  "id": "abc123",
  "branch": Branch,
  "itemChild": ItemChild,
  "quantity": 42,
  "isActive": false
}

Types

BranchItemChildFilterInput

Fields

Input Field	Description
`id` - `StringFilterInput`
`itemChild` - `ItemChildFilterInput`

Example

{
  "id": StringFilterInput,
  "itemChild": ItemChildFilterInput
}

Types

BranchItemChildInput

Fields

Input Field	Description
`branch` - `BranchInput`	Please define branch.id or branch.name
`itemChild` - `ItemChildInput`	Please define itemChild.id or itemChild.itemChildOffer.code or itemChild.itemChildOffer.barcode
`quantity` - `Int`

Example

{
  "branch": BranchInput,
  "itemChild": ItemChildInput,
  "quantity": 42
}

Types

City

Fields

Field Name	Description
`id` - `Int`
`key` - `String`
`province` - `Province`
`isActive` - `Boolean`

Example

{
  "id": 42,
  "key": "xyz789",
  "province": Province,
  "isActive": false
}

Types

CityInput

Fields

Input Field	Description
`id` - `Int`
`key` - `String`
`province` - `ProvinceInput`
`isActive` - `Boolean`

Example

{
  "id": 42,
  "key": "abc123",
  "province": ProvinceInput,
  "isActive": false
}

Types

Country

Fields

Field Name	Description
`id` - `Int`
`key` - `String`
`code2` - `String`
`code3` - `String`
`provinces` - `[Province!]!`
`isActive` - `Boolean`

Example

{
  "id": 42,
  "key": "abc123",
  "code2": "xyz789",
  "code3": "xyz789",
  "provinces": [Province],
  "isActive": true
}

Types

CountryInput

Fields

Input Field	Description
`id` - `Int`
`key` - `String`
`code2` - `String`
`code3` - `String`
`isActive` - `Boolean`

Example

{
  "id": 42,
  "key": "abc123",
  "code2": "xyz789",
  "code3": "abc123",
  "isActive": false
}

Types

Currency

Fields

Field Name	Description
`id` - `Int!`
`key` - `String!`
`code3` - `String!`
`isActive` - `Boolean!`

Example

{
  "id": 42,
  "key": "abc123",
  "code3": "xyz789",
  "isActive": false
}

Types

DateFilterInput

Fields

Input Field	Description
`equalIsActive` - `Boolean`
`equal` - `String`
`notEqualIsActive` - `Boolean`
`notEqual` - `String`
`greaterThanIsActive` - `Boolean`
`greaterThan` - `String`
`lessThanIsActive` - `Boolean`
`lessThan` - `String`

Example

{
  "equalIsActive": false,
  "equal": "abc123",
  "notEqualIsActive": true,
  "notEqual": "xyz789",
  "greaterThanIsActive": true,
  "greaterThan": "xyz789",
  "lessThanIsActive": false,
  "lessThan": "xyz789"
}

Types

File

Fields

Field Name	Description
`id` - `ID`
`url` - `String`
`isPrivate` - `Boolean`
`path` - `String`

Example

{
  "id": "4",
  "url": "xyz789",
  "isPrivate": true,
  "path": "xyz789"
}

Types

Float

Description

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

Example

987.65

Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

Types

Info

Fields

Field Name	Description
`count` - `Int!`	id is unique uuid.

Example

{"count": 42}

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

IntegerFilterInput

Fields

Input Field	Description
`equalIsActive` - `Boolean`
`equal` - `Int`
`notEqualIsActive` - `Boolean`
`notEqual` - `Int`
`greaterThanIsActive` - `Boolean`
`greaterThan` - `Int`
`lessThanIsActive` - `Boolean`
`lessThan` - `Int`

Example

{
  "equalIsActive": true,
  "equal": 42,
  "notEqualIsActive": false,
  "notEqual": 42,
  "greaterThanIsActive": true,
  "greaterThan": 42,
  "lessThanIsActive": true,
  "lessThan": 42
}

Types

Invoice

Fields

Field Name	Description
`id` - `String`
`sellerAccount` - `Account`
`sellerBranch` - `Branch`
`customerAccount` - `Account`
`customerBranch` - `Branch`
`customerReceiverBranch` - `Branch`
`invoiceMovements` - `[InvoiceMovement!]!`
`packages` - `[Package!]!`
`sancode` - `String`
`uuid` - `String`
`code` - `String`
`file` - `File`
`commercialFile` - `File`
`issuedAt` - `String`
`isActive` - `Boolean`
`updatedAt` - `String`
`createdAt` - `String`

Example

{
  "id": "abc123",
  "sellerAccount": Account,
  "sellerBranch": Branch,
  "customerAccount": Account,
  "customerBranch": Branch,
  "customerReceiverBranch": Branch,
  "invoiceMovements": [InvoiceMovement],
  "packages": [Package],
  "sancode": "abc123",
  "uuid": "xyz789",
  "code": "xyz789",
  "file": File,
  "commercialFile": File,
  "issuedAt": "xyz789",
  "isActive": false,
  "updatedAt": "xyz789",
  "createdAt": "abc123"
}

Types

InvoiceMovement

Fields

Field Name	Description
`id` - `String`
`invoice` - `Invoice`
`originBranch` - `Branch`
`destinationBranch` - `Branch`
`logisticsCompanyService` - `LogisticsCompanyService`
`trackingCode` - `String`
`labelFile` - `File`
`labelPrintingIsMandatory` - `Boolean`
`isSynced` - `Boolean`
`isActive` - `Boolean`
`updatedAt` - `String`
`createdAt` - `String`

Example

{
  "id": "abc123",
  "invoice": Invoice,
  "originBranch": Branch,
  "destinationBranch": Branch,
  "logisticsCompanyService": LogisticsCompanyService,
  "trackingCode": "abc123",
  "labelFile": File,
  "labelPrintingIsMandatory": true,
  "isSynced": false,
  "isActive": false,
  "updatedAt": "xyz789",
  "createdAt": "xyz789"
}

Types

ItemChild

Fields

Field Name	Description
`id` - `String!`
`sancode` - `String!`
`code` - `String!`
`gtin` - `String`
`mpn` - `String`
`hsCode` - `String`
`itemChildOffer` - `ItemChildOffer`
`isActive` - `Boolean!`
`updatedAt` - `String!`
`createdAt` - `String!`

Example

{
  "id": "xyz789",
  "sancode": "xyz789",
  "code": "abc123",
  "gtin": "xyz789",
  "mpn": "xyz789",
  "hsCode": "xyz789",
  "itemChildOffer": ItemChildOffer,
  "isActive": false,
  "updatedAt": "abc123",
  "createdAt": "xyz789"
}

Types

ItemChildFilterInput

Fields

Input Field	Description
`id` - `StringFilterInput`
`item` - `ItemFilterInput`

Example

{
  "id": StringFilterInput,
  "item": ItemFilterInput
}

Types

ItemChildInput

Fields

Input Field	Description
`id` - `String`
`itemChildOffer` - `ItemChildOfferInput`

Example

{
  "id": "abc123",
  "itemChildOffer": ItemChildOfferInput
}

Types

ItemChildOffer

Fields

Field Name	Description
`id` - `String!`
`itemChild` - `ItemChild!`
`code` - `String!`
`barcode` - `String!`
`isActive` - `Boolean!`

Example

{
  "id": "xyz789",
  "itemChild": ItemChild,
  "code": "xyz789",
  "barcode": "xyz789",
  "isActive": true
}

Types

ItemChildOfferFilterInput

Fields

Input Field	Description
`id` - `StringFilterInput`	key is unique string.
`code` - `StringFilterInput`
`barcode` - `StringFilterInput`
`itemChild` - `ItemChildFilterInput`

Example

{
  "id": StringFilterInput,
  "code": StringFilterInput,
  "barcode": StringFilterInput,
  "itemChild": ItemChildFilterInput
}

Types

ItemChildOfferInput

Fields

Input Field	Description
`id` - `String`
`itemChild` - `ItemChildInput`
`code` - `String`
`barcode` - `String`
`isActive` - `Boolean`

Example

{
  "id": "abc123",
  "itemChild": ItemChildInput,
  "code": "xyz789",
  "barcode": "xyz789",
  "isActive": false
}

Types

ItemFilterInput

Fields

Input Field	Description
`id` - `StringFilterInput`

Example

{"id": StringFilterInput}

Types

LoginInput

Fields

Input Field	Description
`organization` - `LoginOrganizationInput!`
`user` - `LoginUserInput!`

Example

{
  "organization": LoginOrganizationInput,
  "user": LoginUserInput
}

Types

LoginOrganizationInput

Fields

Input Field	Description
`key` - `String!`

Example

{"key": "xyz789"}

Types

LoginOutput

Fields

Field Name	Description
`token` - `String!`
`expiryTime` - `Float!`

Example

{"token": "abc123", "expiryTime": 123.45}

Types

LoginUserInput

Fields

Input Field	Description
`email` - `String!`
`password` - `String!`

Example

{
  "email": "xyz789",
  "password": "xyz789"
}

Types

LogisticsCompany

Fields

Field Name	Description
`id` - `Int`
`key` - `String`
`name` - `String`
`logoUrl` - `String`
`iconUrl` - `String`
`isActive` - `Boolean`

Example

{
  "id": 42,
  "key": "abc123",
  "name": "abc123",
  "logoUrl": "xyz789",
  "iconUrl": "xyz789",
  "isActive": false
}

Types

LogisticsCompanyService

Fields

Field Name	Description
`id` - `Int`
`logisticsCompany` - `LogisticsCompany`
`key` - `String`
`isActive` - `Boolean`

Example

{
  "id": 42,
  "logisticsCompany": LogisticsCompany,
  "key": "abc123",
  "isActive": false
}

Types

OrderBranch

Fields

Field Name	Description
`id` - `String`
`sancode` - `String`
`currency` - `Currency`
`supplierCurrency` - `Currency`
`supplierAccount` - `Account`
`supplierSenderBranch` - `Branch`
`customerAccount` - `Account`
`customerBranch` - `Branch`
`customerReceiverBranch` - `Branch`
`isWholesale` - `Boolean`
`isActive` - `Boolean`
`updatedAt` - `String`
`createdAt` - `String`
`orderBranchItemChildren` - `[OrderBranchItemChild!]!`
`packages` - `[Package!]!`

Example

{
  "id": "xyz789",
  "sancode": "xyz789",
  "currency": Currency,
  "supplierCurrency": Currency,
  "supplierAccount": Account,
  "supplierSenderBranch": Branch,
  "customerAccount": Account,
  "customerBranch": Branch,
  "customerReceiverBranch": Branch,
  "isWholesale": false,
  "isActive": true,
  "updatedAt": "xyz789",
  "createdAt": "xyz789",
  "orderBranchItemChildren": [OrderBranchItemChild],
  "packages": [Package]
}

Types

OrderBranchFilterInput

Fields

Input Field	Description
`id` - `StringFilterInput`
`sancode` - `StringFilterInput`
`isActive` - `BooleanFilterInput`
`updatedAt` - `DateFilterInput`
`createdAt` - `DateFilterInput`
`orderBranchItemChildren` - `OrderBranchItemChildrenFilterInput`

Example

{
  "id": StringFilterInput,
  "sancode": StringFilterInput,
  "isActive": BooleanFilterInput,
  "updatedAt": DateFilterInput,
  "createdAt": DateFilterInput,
  "orderBranchItemChildren": OrderBranchItemChildrenFilterInput
}

Types

OrderBranchInput

Fields

Input Field	Description
`id` - `String`

Example

{"id": "abc123"}

Types

OrderBranchItemChild

Fields

Field Name	Description
`id` - `String`
`orderBranch` - `OrderBranch`
`itemChild` - `ItemChild`
`currentQuantity` - `Int`
`quantity` - `Int`
`amount` - `Float`
`shippingCost` - `Float`
`discount` - `Float`
`installmentCost` - `Float`
`supplierAmount` - `Float`
`supplierShippingCost` - `Float`
`isApproved` - `Boolean`
`invoicedQuantity` - `Int`
`packedQuantity` - `Int`
`cancelledQuantity` - `Int`
`readyToShipQuantity` - `Int`
`shippedQuantity` - `Int`
`externalShippedQuantity` - `Int`
`orderBranchItemChildStatus` - `OrderBranchItemChildStatus`
`isActive` - `Boolean`

Example

{
  "id": "abc123",
  "orderBranch": OrderBranch,
  "itemChild": ItemChild,
  "currentQuantity": 42,
  "quantity": 42,
  "amount": 123.45,
  "shippingCost": 123.45,
  "discount": 987.65,
  "installmentCost": 123.45,
  "supplierAmount": 987.65,
  "supplierShippingCost": 123.45,
  "isApproved": false,
  "invoicedQuantity": 42,
  "packedQuantity": 42,
  "cancelledQuantity": 42,
  "readyToShipQuantity": 42,
  "shippedQuantity": 42,
  "externalShippedQuantity": 42,
  "orderBranchItemChildStatus": OrderBranchItemChildStatus,
  "isActive": false
}

Types

OrderBranchItemChildInput

Fields

Input Field	Description
`id` - `String`
`isApproved` - `Boolean`

Example

{"id": "xyz789", "isApproved": true}

Types

OrderBranchItemChildStatus

Fields

Field Name	Description
`id` - `Int`
`key` - `String`
`isActive` - `Boolean`

Example

{
  "id": 42,
  "key": "xyz789",
  "isActive": false
}

Types

OrderBranchItemChildStatusFilterInput

Fields

Input Field	Description
`id` - `IntegerFilterInput`	key is unique string.

Example

{"id": IntegerFilterInput}

Types

OrderBranchItemChildrenFilterInput

Fields

Input Field	Description
`id` - `StringFilterInput`
`isApproved` - `BooleanFilterInput`
`packedQuantity` - `IntegerFilterInput`
`cancelledQuantity` - `IntegerFilterInput`
`readyToShipQuantity` - `IntegerFilterInput`
`shippedQuantity` - `IntegerFilterInput`
`deliveredQuantity` - `IntegerFilterInput`
`returnedQuantity` - `IntegerFilterInput`
`orderBranchItemChildStatus` - `OrderBranchItemChildStatusFilterInput`

Example

{
  "id": StringFilterInput,
  "isApproved": BooleanFilterInput,
  "packedQuantity": IntegerFilterInput,
  "cancelledQuantity": IntegerFilterInput,
  "readyToShipQuantity": IntegerFilterInput,
  "shippedQuantity": IntegerFilterInput,
  "deliveredQuantity": IntegerFilterInput,
  "returnedQuantity": IntegerFilterInput,
  "orderBranchItemChildStatus": OrderBranchItemChildStatusFilterInput
}

Types

Package

Fields

Field Name	Description
`id` - `String`
`orderBranch` - `OrderBranch`
`invoice` - `Invoice`
`sancode` - `String`
`shippedAt` - `String`
`readyToShipAt` - `String`
`closedAt` - `String`
`progressStartedAt` - `String`
`departedAt` - `String`
`outForDeliveryAt` - `String`
`deliveredAt` - `String`
`labelFile` - `File`
`isActive` - `Boolean`
`updatedAt` - `String`
`createdAt` - `String`
`packageItemChildren` - `[PackageItemChild!]!`

Example

{
  "id": "xyz789",
  "orderBranch": OrderBranch,
  "invoice": Invoice,
  "sancode": "abc123",
  "shippedAt": "xyz789",
  "readyToShipAt": "abc123",
  "closedAt": "xyz789",
  "progressStartedAt": "abc123",
  "departedAt": "xyz789",
  "outForDeliveryAt": "abc123",
  "deliveredAt": "xyz789",
  "labelFile": File,
  "isActive": false,
  "updatedAt": "xyz789",
  "createdAt": "xyz789",
  "packageItemChildren": [PackageItemChild]
}

Types

PackageInput

Description

You have to define id or sancode of order package.

Fields

Input Field	Description
`id` - `String`
`sancode` - `String`
`readyToShipAt` - `String`	You have to pass value with "time-now" for update ready to ship status. Sanbuyos will replace "time-now" with real UTC time.
`shippedAt` - `String`	You have to pass value with "time-now" for update shipped status. Sanbuyos will replace "time-now" with real UTC time. You have to update readyToShipAt before shippedAt.

Example

{
  "id": "xyz789",
  "sancode": "xyz789",
  "readyToShipAt": "xyz789",
  "shippedAt": "xyz789"
}

Types

PackageItemChild

Fields

Field Name	Description
`id` - `String`
`package` - `Package`
`itemChild` - `ItemChild`
`quantity` - `Int`
`isActive` - `Boolean`
`updatedAt` - `String`
`createdAt` - `String`

Example

{
  "id": "abc123",
  "package": Package,
  "itemChild": ItemChild,
  "quantity": 42,
  "isActive": false,
  "updatedAt": "xyz789",
  "createdAt": "abc123"
}

Types

PaginationInput

Fields

Input Field	Description
`page` - `Int!`
`size` - `Int!`

Example

{"page": 42, "size": 42}

Types

PostalCode

Fields

Field Name	Description
`id` - `Int`
`value` - `String`
`country` - `Country`
`isActive` - `Boolean`

Example

{
  "id": 42,
  "value": "abc123",
  "country": Country,
  "isActive": false
}

Types

PostalCodeInput

Fields

Input Field	Description
`id` - `Int`
`value` - `String`
`country` - `CountryInput`
`isActive` - `Boolean`

Example

{
  "id": 42,
  "value": "abc123",
  "country": CountryInput,
  "isActive": true
}

Types

Province

Fields

Field Name	Description
`id` - `Int`
`key` - `String`
`country` - `Country`
`cities` - `[City!]!`
`isActive` - `Boolean`

Example

{
  "id": 42,
  "key": "abc123",
  "country": Country,
  "cities": [City],
  "isActive": true
}

Types

ProvinceInput

Fields

Input Field	Description
`id` - `Int`
`key` - `String`
`country` - `CountryInput`
`isActive` - `Boolean`

Example

{
  "id": 42,
  "key": "abc123",
  "country": CountryInput,
  "isActive": false
}

Types

String

Description

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

Example

"xyz789"

Types

StringFilterInput

Fields

Input Field	Description
`equalIsActive` - `Boolean`
`equal` - `String`
`notEqualIsActive` - `Boolean`
`notEqual` - `String`

Example

{
  "equalIsActive": true,
  "equal": "xyz789",
  "notEqualIsActive": false,
  "notEqual": "xyz789"
}

Documentation by Anvil SpectaQL