Skip to main content

Orders

Models

Order

type Order {
id: ID!
abandonedCartFlows: [AbandonedCartFlow!]
archived: Boolean!
attributes: [OrderAttributeValue!]
availableShippingMethods: [AvailableShippingMethod!]
billingAddress: OrderAddress
branch: OrderBranch
branchSession: OrderBranchSession
branchSessionId: String
campaignOffers: [CartV2CampaignOffer!]
cancelledAt: Timestamp
cancelReason: OrderCancelledReasonEnum
cartId: String
cartStatus: CartV2StatusEnum
checkoutId: String
clientIp: String
couponCode: String
createdBy: CartCreatedByEnum
currencyCode: String!
currencyRates: [OrderCurrencyRate!]!
currencySymbol: String
customer: OrderCustomer
customerId: String
customerOrderCount: Float
dueDate: Timestamp
giftPackageLines: [OrderGiftPackageLine!]
giftPackageNote: String
host: String
invoices: [Invoice!]
isGiftPackage: Boolean
itemCount: Float
lastActivityDate: Timestamp
marketingCampaignId: String
merchantId: String!
note: String
orderAdjustments: [OrderAdjustment!]
orderedAt: Timestamp
orderLineItems: [OrderLineItem!]!
orderNumber: String
orderPackages: [OrderPackage!]
orderPackageSequence: Float
orderPackageStatus: OrderPackageStatusEnum
orderPaymentStatus: OrderPaymentStatusEnum
orderSequence: Float
orderTagIds: [String!]
paymentMethods: [OrderPaymentMethod!]
priceList: OrderPriceList
priceListId: String
recoverEmailStatus: CheckoutRecoveryEmailStatusEnum
recoveryStatus: CheckoutRecoveryStatusEnum
salesChannel: OrderSalesChannel!
salesChannelId: String
sessionInfo: OrderSessionInfo
shippingAddress: OrderAddress
shippingLines: [OrderShippingLine!]
shippingMethod: OrderShippingMethodEnum!
shippingSettingsId: String
shippingZoneRateId: String
sourceId: String
staff: OrderStaff
status: OrderStatusEnum!
stockLocation: OrderStockLocation
stockLocationId: String
storefront: OrderStorefront
storefrontId: String
storefrontRouting: OrderStorefrontRouting
storefrontRoutingId: String
storefrontTheme: OrderStorefrontTheme
storefrontThemeId: String
taxLines: [OrderTaxLine!]
terminalId: String
totalFinalPrice: Float!
totalPrice: Float!
userAgent: String
}

Fields

idID!required
abandonedCartFlows[AbandonedCartFlow!]
archivedBoolean!required
availableShippingMethods[AvailableShippingMethod!]
billingAddressOrderAddress

It is the billing address of the order.

It is the branch information of the orders created via ikasPOS.

branchSessionOrderBranchSession

It is the branchSession information of the orders created via ikasPOS.

branchSessionIdString
cancelledAtTimestamp

If the order has been cancelled, it indicates the cancellation date of the order.

It is the cancel reason of the order. If the order has been cancelled, it indicates the cancellation reason of the order.

cartIdString

Shows the status of the cart linked to the order.

checkoutIdString
clientIpString

The client ip address.

couponCodeString

Indicates who created the order. The order can be created by the customer or the store owner.

currencyCodeString!required

It is the currency value of the order.

currencyRates[OrderCurrencyRate!]!required

A list of currency rate objects.

currencySymbolString

Information about the customer. The order does not have to be a customer information. If the order was created by ikasPOS, the customer information may be null.

customerIdString
customerOrderCountFloat

It shows the number of orders given by the relevant customer.

dueDateTimestamp
giftPackageLines[OrderGiftPackageLine!]

A list of gift package line objects, each containing information about a gift package pricing in the order.

giftPackageNoteString

An optional gift package note, can attach to the order.

hostString

It is the host where the order was created.

invoices[Invoice!]

A list of invoice objects, each containing information about an invoice.

isGiftPackageBoolean

Indicates whether there is a gift package in the order. isGiftPackage returns true if the order has gift package

itemCountFloat
lastActivityDateTimestamp
marketingCampaignIdString
merchantIdString!required
noteString

An optional note, can attach to the order.

orderAdjustments[OrderAdjustment!]

A list of adjustment objects, each containing information about a adjustment in the order.

orderedAtTimestamp

The date the order was ordered.

orderLineItems[OrderLineItem!]!required

A list of line item objects, each containing information about an item in the order.

orderNumberString

The position of the order in the store's order count starting from 1001. Order numbers are sequential and start from 1001.

orderPackages[OrderPackage!]

A list of order package objects.

orderPackageSequenceFloat

is the sequence value of the packages in the order.

orderPackageStatusOrderPackageStatusEnum

It is the package status enum of the order

orderPaymentStatusOrderPaymentStatusEnum

It is the payment status enum of the order

orderSequenceFloat

It is the sequence value of the order_number. The sequence value starts from 1 and an order with order number 1001 has a sequence value of 1.

orderTagIds[String!]

It is the tag id list in the order.

paymentMethods[OrderPaymentMethod!]

A list of payment method objects, each containing information about a payment method in the order.

Information about the priceList used when the order was created.

priceListIdString
salesChannelOrderSalesChannel!required

Information about the salesChannel where the order was created.

salesChannelIdString
sessionInfoOrderSessionInfo
shippingAddressOrderAddress

It is the shipping address of the order.

A list of shipping line objects, each containing information about a shipping in the order.

shippingMethodOrderShippingMethodEnum!required

It is the shipping method enum of the order

shippingSettingsIdString
shippingZoneRateIdString
sourceIdString

It is the staff information of the orders created via ikasPOS.

statusOrderStatusEnum!required

It is the status enum of the order

stockLocationOrderStockLocation

It is the stock location information of the orders.

stockLocationIdString
storefrontOrderStorefront

Information about the storefront where the order was created.

storefrontIdString
storefrontRoutingOrderStorefrontRouting

Information about the storefrontRouting used by the storefront at the time the order was created.

storefrontRoutingIdString
storefrontThemeOrderStorefrontTheme

Information about the storefrontTheme used by the storefront at the time the order was created.

storefrontThemeIdString

A list of tax line objects, tax line objects contain the taxes of the shippingLines, orderLineItems, and giftPackageLines.

terminalIdString

It is the `terminalId`` information of the orders created via ikasPOS.

totalFinalPriceFloat!required

The total final price of the order resulting from the apply of orderAdjustments , shippingLines, and giftPackageLines pricing to the order total price.

totalPriceFloat!required

It is the sum of the net prices of the line items in the order.

userAgentString

Details of the browsing client, including software and operating versions.

OrderAddress

type OrderAddress {
id: String
addressLine1: String!
addressLine2: String
city: OrderAddressCity!
company: String
country: OrderAddressCountry!
district: OrderAddressDistrict
firstName: String!
identityNumber: String
isDefault: Boolean!
lastName: String!
phone: String
postalCode: String
region: OrderAddressRegion
state: OrderAddressState
taxNumber: String
taxOffice: String
}

Fields

The address"s id of the order address.

addressLine1String!required

The street address of the address.

addressLine2String

An optional additional field for the street address of the address.

cityOrderAddressCity!required

The city information of the address.

companyString

The company of the person associated with the address.

countryOrderAddressCountry!required

The country information of the address.

The district information of the address.

firstNameString!required

The first name of the person associated with the address

identityNumberString

The identity number of the person associated with the address.

isDefaultBoolean!required

The address"s id of the order address.

lastNameString!required

The last name of the person associated with the address

phoneString

The phone of the person associated with the address.

postalCodeString

The postal code of the address.

The region information of the address.

The state information of the address.

taxNumberString

The tax number of the person associated with the address.

taxOfficeString

The tax office of the person associated with the address.

OrderAddressCountry

type OrderAddressCountry {
id: String
code: String
iso2: String
iso3: String
name: String!
}

Fields

It is the id of the country of the address.

codeString

It is the code of the country of the address.

iso2String

It is the two-letter code of the country of the address.

iso3String

It is the three-letter code of the country of the address.

nameString!required

It is the name of the country of the address.

OrderAddressCity

type OrderAddressCity {
id: String
code: String
name: String!
}

Fields

It is the id of the city of the address.

codeString

It is the code of the city of the address.

nameString!required

It is the name of the city of the address.

OrderAddressDistrict

type OrderAddressDistrict {
id: String
code: String
name: String
}

Fields

It is the id of the district of the address.

codeString

It is the code of the district of the address.

nameString

It is the name of the district of the address.

OrderAddressState

type OrderAddressState {
id: String
code: String
name: String
}

Fields

It is the id of the state of the address.

codeString

It is the code of the state of the address.

nameString

It is the name of the state of the address.

OrderLineItem

type OrderLineItem {
id: ID!
bundleProductSettings: BundleProductOrderLine
currencyCode: String
currencySymbol: String
discount: OrderLineDiscount
discountPrice: Float
finalPrice: Float
finalUnitPrice: Float
options: [OrderLineOption!]
originalOrderLineItemId: String
price: Float!
quantity: Float!
sourceId: String
status: OrderLineItemStatusEnum!
statusUpdatedAt: Timestamp
stockLocationId: String
taxValue: Float
unitPrice: Float
variant: OrderLineVariant!
}

Fields

idID!required
bundleProductSettingsBundleProductOrderLine

It is the option information of the variant value in the order line item.

currencyCodeString

It is the currency code of the order line item.

currencySymbolString

Information about the discount. Shows the details of the discount applied to the order line item.

discountPriceFloat

It is the discount price of the order line item.

finalPriceFloat

It is the final price of the order line item. If the discount price is less than the sell price, the final price is equal to the discount price.

finalUnitPriceFloat

It is the unit price of the order line item.

It is the option information of the variant value in the order line item.

originalOrderLineItemIdString

It is the original order line item id of the line item. If the line item is derived from another line item, this field is filled.

priceFloat!required

It is the selling price of the order line item.

quantityFloat!required

It is the quantity of variant in the order line item.

sourceIdString

It is the status enum of the order line item

statusUpdatedAtTimestamp

It is the date when the last status of the order line item was updated.

stockLocationIdString

It is the stock location id of the variant value in the order line item.

taxValueFloat

It is the tax value of the order line item.

unitPriceFloat

It is the unit price of the order line item.

variantOrderLineVariant!required

Information about the variant of the order line item.

OrderLineVariant

type OrderLineVariant {
id: String
barcodeList: [String!]
baseUnit: OrderLineBaseUnit
brand: OrderLineVariantBrand
bundleProducts: [OrderLineVariantBundleProductModel!]
categories: [OrderLineVariantCategory!]
fileId: String
hsCode: String
mainImageId: String
name: String!
prices: [OrderLineVariantPrice!]
productId: String
productVolumeDiscountId: String
sku: String
slug: String
tagIds: [String!]
tags: [OrderLineVariantTag!]
taxValue: Float
type: Float
unit: OrderLineVariantUnit
variantValues: [OrderLineVariantVariantValues!]
weight: Float
}

Fields

It is the id of the variant.

barcodeList[String!]

It is the barcode list of the variant.

Information about the brand of variant.

Information about the brand of variant.

Shows the list of bundle products in the line item.

A list of category objects, each containing information about a category in the variant.

fileIdString

It is the id of the product file.

hsCodeString

It is the hasCode of the variant.

mainImageIdString

It is the main image id of the variant.

nameString!required

It is the name of the variant.

It is the price list of the variant. Different price lists may have different pricing.

productIdString

It is the product id of the variant.

productVolumeDiscountIdString

It is the product volume discount id of the product.

It is the sku of the variant.

slugString

It is the slug of the variant. The slug value is unique each variant and product.

tagIds[String!]

It is the the tag id list

A list of tag objects, each containing information about a tag in the variant.

taxValueFloat

It is the tax value of the variant.

typeFloat

Information about the brand of variant.

It is the variant values of the variant.

weightFloat

OrderLineVariantVariantValues

type OrderLineVariantVariantValues {
order: Float!
variantTypeId: String!
variantTypeName: String
variantValueId: String!
variantValueName: String
}

Fields

orderFloat!required

It is the order of variant value. The variant value order starts from 0.

variantTypeIdString!required

It is the order of variant value. The variant value order starts from 0.

variantTypeNameString

It is the order of variant value. The variant value order starts from 0.

variantValueIdString!required

It is the order of variant value. The variant value order starts from 0.

variantValueNameString

It is the order of variant value. The variant value order starts from 0.

OrderLineVariantPrice

type OrderLineVariantPrice {
buyPrice: Float
currency: String
currencySymbol: String
discountPrice: Float
priceListId: String
sellPrice: Float!
unitPrice: Float
}

Fields

buyPriceFloat

It is the buy price of variant.

currencyString

It is the currency code of variant.

currencySymbolString
discountPriceFloat

It is the discount price of variant.

priceListIdString

It is the id of the price list to which the variant is associated.

sellPriceFloat!required

It is the sell price of variant.

unitPriceFloat

It is the unit price of variant.

OrderLineVariantCategory

type OrderLineVariantCategory {
id: String!
categoryPath: [OrderLineVariantCategoryPath!]
name: String!
}

Fields

idString!required

It is the id of the category of the variant.

It is the path of the category.

nameString!required

It is the name of the category.

OrderLineVariantBrand

type OrderLineVariantBrand {
id: String!
name: String!
}

Fields

idString!required

It is the id of the brand of the variant.

nameString!required

It is the name of the category.

OrderLineOption

type OrderLineOption {
name: String!
productOptionId: String!
productOptionsSetId: String!
type: ProductOptionTypeEnum!
values: [OrderLineOptionValue!]!
}

Fields

nameString!required

It is the name of order line option in the order line item.

productOptionIdString!required

It is the product option id of the product in the order line item.

productOptionsSetIdString!required

It is the product option set id of the product in the order line item.

It is the type of the order line option.

OrderAdjustment

type OrderAdjustment {
amount: Float!
amountType: OrderAmountTypeEnum!
appliedOrderLines: [OrderAdjustmentAppliedOrderLine!]
campaignId: String
campaignType: CampaignTypeEnum
couponId: String
name: String!
order: Float!
transactionId: String
type: OrderAdjustmentEnum!
}

Fields

amountFloat!required

It is the adjustment amount in the order. This amount can be positive or negative.

amountTypeOrderAmountTypeEnum!required

A list of order line items, each containing information about a order line item in the order.

campaignIdString

If the adjustment is associated to the campaign, it will show the campaign id.

campaignTypeCampaignTypeEnum

If the adjustment is associated to the campaign, it will show the campaign id.

couponIdString

It is the coupon id generated depending on the campaign.

nameString!required

It is the name of the adjustment.

orderFloat!required

It is the order of the adjustment. Adjustments are applied in this order.

transactionIdString

The amount is the id of the transaction.

OrderLineOptionValue

type OrderLineOptionValue {
name: String
price: Float
value: String!
}

Fields

nameString
priceFloat
valueString!required

OrderAdjustmentAppliedOrderLine

type OrderAdjustmentAppliedOrderLine {
amount: Float!
appliedQuantity: Float!
isAutoCreated: Boolean
orderLineId: String!
}

Fields

amountFloat!required

Is he amount of the applied adjustment.

appliedQuantityFloat!required

It is the quantity of variants within the order line item to which the adjustment is applied.

isAutoCreatedBoolean

It is the quantity of variants within the order line item to which the adjustment is applied.

orderLineIdString!required

It is the id of the order line item to which the adjustment is applied.

OrderShippingLine

type OrderShippingLine {
finalPrice: Float!
isRefunded: Boolean
paymentMethod: PaymentMethodTypeEnum
price: Float!
priceListId: String
shippingSettingsId: String
shippingZoneRateId: String
taxValue: Float
title: String!
transactionId: String
}

Fields

finalPriceFloat!required

It is the final price after discounts are applied.

isRefundedBoolean

Indicates whether the shipping cost is refunded if the order is refunded. isRefunded returns true if the amount is refunded.

Indicates whether the shipping cost is refunded if the order is refunded. isRefunded returns true if the amount is refunded.

priceFloat!required

It is the price of the order shipping line.

priceListIdString
shippingSettingsIdString

It is the shipping settings id of the order shipping line.

shippingZoneRateIdString

It is the shipping zone rate id of the order shipping line.

taxValueFloat

It is the tax value of the order shipping line price.

titleString!required

It is the title of the order shipping line.

transactionIdString

The amount is the id of the transaction.

OrderGiftPackageLine

type OrderGiftPackageLine {
isRefunded: Boolean
price: Float!
priceListId: String
taxValue: Float
}

Fields

isRefundedBoolean

Indicates whether the gift cost is refunded if the order is refunded. isRefunded returns true if the amount is refunded.

priceFloat!required

It is the price of the order gift package line.

priceListIdString
taxValueFloat

It is the tax value of the order gift package line price.

OrderCustomer

type OrderCustomer {
id: String
email: String
firstName: String
fullName: String
isGuestCheckout: Boolean
lastName: String
notificationsAccepted: Boolean
phone: String
preferredLanguage: String
}

Fields

It is the id of the customer who created the order.

emailString

It is the email of the customer who created the order.

firstNameString

It is the first name of the customer who created the order.

fullNameString

It is the full name name of the customer who created the order.

isGuestCheckoutBoolean

Indicates whether the order was created by a new customer with no email record. isGuestCheckout returns true if the order was created without customer email information.

lastNameString

It is the last name of the customer who created the order.

notificationsAcceptedBoolean
phoneString

It is the phone number of the customer who created the order.

preferredLanguageString

It is the preferred language of the customer who created the order.

OrderTaxLine

type OrderTaxLine {
price: Float!
rate: Float!
}

Fields

priceFloat!required

It is the price of the order tax.

rateFloat!required

It is the percentage of the slice to which the calculated tax amount belongs.

OrderPackage

type OrderPackage {
id: ID!
errorMessage: String
note: String
orderLineItemIds: [String!]!
orderPackageFulfillStatus: OrderPackageFulfillStatusEnum!
orderPackageNumber: String!
sourceId: String
stockLocationId: String!
trackingInfo: TrackingInfo
}

Fields

idID!required
errorMessageString

If the package was sent via the cargo application and received an error, this field is filled with an error message.

noteString

An optional note, can attach to the order package.

orderLineItemIds[String!]!required

It is the id list of the order line items in the package.

orderPackageFulfillStatusOrderPackageFulfillStatusEnum!required

It is the fulfill status of the package

orderPackageNumberString!required

It is the number of order package. Order package number is created with the order number - order package sequence format.

sourceIdString
stockLocationIdString!required
trackingInfoTrackingInfo

It is the stock location id information where the package will be shipped.

OrderPackageTrackingInfo

type TrackingInfo {
barcode: String
cargoCompany: String
cargoCompanyId: String
isSendNotification: Boolean
trackingLink: String
trackingNumber: String
}

Fields

barcodeString

It is the barcode of the order package.

cargoCompanyString

It is the name of the cargo company.

cargoCompanyIdString

It is the key of the cargo company which can be retrieved via listCargoCompany query.

isSendNotificationBoolean

Indicates whether the notification is sent to the customer after the cargo is delivered. isSendNotification returns true if the notification is sent.

trackingLinkString

It is the tracking link of the order package.

trackingNumberString

It is the tracking number of the order package.

OrderCurrencyRate

type OrderCurrencyRate {
code: String!
originalRate: Float!
rate: Float!
}

Fields

codeString!required

It is the code of the currency.

originalRateFloat!required

It is the original rate of the currency.

rateFloat!required

It is the rate of the currency.

OrderStorefront

type OrderStorefront {
id: String!
name: String
}

Fields

idString!required

It is the storefront id where the order was created.

nameString

It is the storefront name id where the order was created.

OrderSalesChannel

type OrderSalesChannel {
id: String!
name: String
type: Float
}

Fields

idString!required

It is the sales channel id where the order was created.

nameString

It is the sales channel name where the order was created.

typeFloat

It is the sales channel type where the order was created.

OrderStorefrontTheme

type OrderStorefrontTheme {
id: String!
name: String
themeId: String
themeVersionId: String
}

Fields

idString!required

It is the theme id customized by the merchant used by the storefront when the order was created.

nameString

It is the theme theme name customized by the merchant used by the storefront when the order was created.

themeIdString

It is the ikas theme id used by the storefront when the order was created.

themeVersionIdString

It is the ikas theme version id used by the storefront when the order was created.

OrderStorefrontRouting

type OrderStorefrontRouting {
id: String!
domain: String
dynamicCurrencySettings: OrderStorefrontRoutingDynamicCurrencySettings
locale: String
path: String
priceListId: String
}

Fields

idString!required

It is the storefront routing id used by the storefront when the order was created.

domainString

It is the domain of the storefront routing.

localeString

It is the locale of the storefront routing.

pathString

It is the path of the storefront routing.

priceListIdString

It is the price list id that associated on the storefront routing.

OrderPriceList

type OrderPriceList {
id: String!
name: String
}

Fields

idString!required

It is the id of the price list.

nameString

It is the name of the price list.

OrderBranch

type OrderBranch {
id: String!
name: String
}

Fields

idString!required

It is the id of the branch where the order was created.

nameString

It is the name of the branch where the order was created.

OrderStaff

type OrderStaff {
id: String!
email: String!
firstName: String!
lastName: String!
}

Fields

idString!required

It is the first name of the staff who created the order.

emailString!required

It is the email of the staff who created the order.

firstNameString!required

It is the first name of the staff who created the order.

lastNameString!required

It is the last name of the staff who created the order.

OrderInvoice

type Invoice {
id: String!
appId: String!
appName: String!
hasPdf: Boolean
invoiceData: JSON
invoiceNumber: String!
storeAppId: String!
type: InvoiceTypeEnum!
}

Fields

idString!required

It is the id of the order invoice.

appIdString!required

It is the id of the order invoice.

appNameString!required

It is the id of the order invoice.

hasPdfBoolean

It is indicates that the invoice has the pdf.

invoiceDataJSON

It is data of the invoice.

invoiceNumberString!required

It is the id of the order invoice.

storeAppIdString!required

It is the id of the order invoice.

typeInvoiceTypeEnum!required

It is the type enum of the invoice.

OrderPaymentMethod

type OrderPaymentMethod {
paymentGatewayCode: String
paymentGatewayId: String
paymentGatewayName: String
price: Float!
type: PaymentMethodTypeEnum!
}

Fields

paymentGatewayCodeString

It is the gateway code of the order payment method.

paymentGatewayIdString

It is the gateway name of the order payment method.

paymentGatewayNameString

It is the gateway name of the order payment method.

priceFloat!required

It is the amount charged by the payment method.

It is the type enum of the order payment method.

Queries

List Orders

listOrder(
branchId: StringFilterInput
branchSessionId: StringFilterInput
closedAt: DateFilterInput
customerEmail: StringFilterInput
customerId: StringFilterInput
id: StringFilterInput
invoicesStoreAppId: StringFilterInput
orderNumber: StringFilterInput
orderPackageStatus: OrderPackageStatusEnumInputFilter
orderPaymentStatus: OrderPaymentStatusEnumInputFilter
orderTagIds: StringFilterInput
orderedAt: DateFilterInput
pagination: PaginationInput
paymentMethodType: OrderPaymentMethodEnumFilterInput
salesChannelId: StringFilterInput
search: String
shippingMethod: OrderShippingMethodEnumFilterInput
sort: String
status: OrderStatusEnumInputFilter
stockLocationId: StringFilterInput
terminalId: StringFilterInput
updatedAt: DateFilterInput
): OrderPaginationResponse!

Arguments

branchSessionIdStringFilterInput
customerEmailStringFilterInput
invoicesStoreAppIdStringFilterInput
paginationPaginationInput

With the pagination feature in the data returned as a response, you can filter the data and display the part you want.

salesChannelIdStringFilterInput
searchString

Some listing APIs have searchable fields. You can search in these fields as you wish. For example, in an API; Let the searchableFields :['name', 'description']. If we send search: AAA as input in args, it will return records with 'AAA' in both the name and description fields.

sortString

Some listing APIs have sortable fields. Using these fields, the data returned as response has been sorted. For example, in an API; Let it be sortableFields: ['updatedAt']. The data returned as a response will be sorted according to updatedAt.

stockLocationIdStringFilterInput

Return Type

OrderPaginationResponseOrderPaginationResponse

Mutations

Update Order Package Status

Use this mutation to update the status of packages linked to an order and the status of the order based on the status of those packages.

updateOrderPackageStatus(
input: UpdateOrderPackageStatusInput!
): Order!

Arguments

Return Type

OrderOrder

Fulfill Order

Use this mutation to fulfill order line items.

fulfillOrder(
input: FulFillOrderInput!
): Order!

Arguments

inputFulFillOrderInput!required

Return Type

OrderOrder

Add Order Invoice

Use this mutation to add invoice to order.

addOrderInvoice(
input: AddOrderInvoiceInput!
): Order

Arguments

Return Type

OrderOrder

Create Order with Transactions

Use this mutation if you want to create a new order with transactions.

createOrderWithTransactions(
input: CreateOrderWithTransactionsInput!
): Order!

Arguments

Return Type

OrderOrder

Cancel Fulfillment

Use this mutation to cancel the already created package for an order.

cancelFulfillment(
input: CancelFulfillmentInput!
): Order!

Arguments

Return Type

OrderOrder

Update Order Line

Use this mutation to cancel the fulfillment of the already created package for an order.

updateOrderLine(
input: UpdateOrderInput!
): Order!

Arguments

inputUpdateOrderInput!required

Return Type

OrderOrder

Refund Order Line

Use this mutation to refund given order lines.

refundOrderLine(
input: OrderRefundInput!
): Order!

Arguments

inputOrderRefundInput!required

Return Type

OrderOrder

Update Order Addresses

Use this mutation for order address information changes.

updateOrderAddresses(
input: UpdateOrderAddressesInput!
): Order!

Arguments

Return Type

OrderOrder

Examples

List Orders

curl --location --request POST 'https://api.myikas.com/api/v1/admin/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_access_token>' \
--data-raw '{"query":"{ listOrder { data { billingAddress { addressLine1 addressLine2 city { code id name } company country { code id iso2 iso3 name } district { code id name } firstName id identityNumber isDefault lastName phone postalCode state { code id name } taxNumber taxOffice } branch { id name } branchSessionId cancelReason cancelledAt clientIp createdAt currencyCode currencyRates { code originalRate rate } customer { email firstName id identityNumber isGuestCheckout lastName phone } deleted giftPackageLines { price taxValue } giftPackageNote host id invoices { appId appName createdAt id invoiceNumber storeAppId type } isGiftPackage merchantId note orderAdjustments { amount amountType appliedOrderLines { amount appliedQuantity orderLineId } campaignId couponId name order type } orderLineItems { createdAt currencyCode deleted discount { amount amountType reason } discountPrice finalPrice id options { name productOptionId productOptionsSetId type values { name price value } } originalOrderLineItemId price quantity status statusUpdatedAt stockLocationId taxValue updatedAt variant { barcodeList brand { id name } categories { categoryPath { id name } id name } id mainImageId name prices { buyPrice currency discountPrice priceListId sellPrice } productId sku slug tagIds taxValue type variantValues { order variantTypeId variantTypeName variantValueId variantValueName } } } orderNumber orderPackageSequence orderPackageStatus orderPackages { createdAt deleted errorMessage id note orderLineItemIds orderPackageFulfillStatus orderPackageNumber stockLocationId trackingInfo { barcode cargoCompany isSendNotification trackingLink trackingNumber } updatedAt } orderPaymentStatus orderSequence orderTagIds orderedAt paymentMethods { price type } priceList { id name } salesChannel { id name type } shippingAddress { addressLine1 addressLine2 city { code id name } company country { code id iso2 iso3 name } district { code id name } firstName id identityNumber isDefault lastName phone postalCode state { code id name } taxNumber taxOffice } shippingLines { isRefunded price shippingSettingsId shippingZoneRateId taxValue title } shippingMethod staff { email firstName lastName } status storefront { id name } storefrontRouting { domain id locale path priceListId } storefrontTheme { id name themeId themeVersionId } taxLines { price rate } terminalId totalFinalPrice totalPrice updatedAt userAgent } } }"}'

Response

{
"data": {
"listOrder": {
"data": [
{
"billingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"cancelReason": null,
"cancelledAt": null,
"clientIp": "176.42.29.28",
"createdAt": 1637759203328,
"currencyCode": "TRY",
"currencyRates": [],
"customer": {
"email": "ikas@ikas.com",
"firstName": "ikas",
"id": "fa8b6fbc-210d-4488-88ab-a7bea0a2648b",
"identityNumber": null,
"lastName": "docs",
"phone": null
},
"deleted": false,
"host": "apidocs.myikas.dev",
"id": "84ffbfd2-c92c-4f22-9675-8d3edb7a9084",
"merchantId": "75d8a449-2feb-4230-9eb4-9014673324d5",
"note": null,
"orderAdjustments": [
{
"amount": 149.5,
"amountType": "AMOUNT",
"campaignId": "653aa7c2-4d3c-42ba-aba9-94060f52660d",
"couponId": null,
"name": "Kargo Bypass",
"order": 1,
"type": "DECREMENT"
}
],
"orderLineItems": [
{
"createdAt": 1638189270536,
"currencyCode": "TRY",
"deleted": false,
"discount": null,
"discountPrice": null,
"finalPrice": 149.5,
"id": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"originalOrderLineItemId": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"price": 299,
"quantity": 1,
"status": "FULFILLED",
"statusUpdatedAt": null,
"stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
"taxValue": null,
"updatedAt": 1638189270536,
"variant": {
"barcodeList": [],
"id": "bd9b2bd8-0110-4ded-84c0-b8298332e469",
"mainImageId": "e047ce73-8b77-40f0-8f13-eff9c2b05f4f",
"name": "ikas Ürünü Siyah Kılıf - iPhone 11 Pro Max Kılıf Silikon",
"productId": "62bca022-12be-4e2b-a9dd-90c67cb89dcb",
"sku": null,
"slug": "ikas-urunu-siyah-kilif-iphone-11-pro-max-kilif-silikon",
"tagIds": [],
"taxValue": null,
"variantValues": []
},
"options": []
}
],
"orderNumber": "1028",
"orderPackageStatus": "FULFILLED",
"orderPackages": [
{
"createdAt": 1638189270536,
"deleted": false,
"errorMessage": null,
"id": "a103735c-ece8-4a8f-9576-489f45c4487b",
"note": null,
"orderLineItemIds": ["0a6f539f-8338-400c-a3fc-2bc15c01da58"],
"orderPackageFulfillStatus": "FULFILLED",
"orderPackageNumber": "1028-1",
"stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
"trackingInfo": {
"barcode": "123456",
"cargoCompany": "UPS",
"isSendNotification": null,
"trackingLink": null,
"trackingNumber": "123456"
},
"updatedAt": 1638189270536
}
],
"orderPaymentStatus": "PAID",
"orderSequence": 28,
"orderTagIds": [],
"orderedAt": 1637759203143,
"paymentMethods": [
{
"price": 170.5,
"type": "MONEY_ORDER"
}
],
"priceList": null,
"salesChannel": {
"id": "9fa400f3-fbf1-4ee7-bc26-3cae7f9c3427",
"name": "Jack",
"type": 1
},
"shippingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"shippingLines": [
{
"price": 21,
"shippingSettingsId": "ee4cc76c-f0c3-469f-ab8e-cc14b17fe78c",
"shippingZoneRateId": "db02cc2d-5ba3-4b5b-8147-fee010faca21",
"taxValue": null,
"title": "Kkk",
"isRefunded": null
}
],
"shippingMethod": "SHIPMENT",
"status": "CREATED",
"storefront": {
"id": "8b742b03-c8f8-4509-858c-f9487c3701f2",
"name": "Jack"
},
"storefrontRouting": {
"domain": "tr",
"id": "d3d0b8d9-76c6-436b-a1ba-024c1f4f4a12",
"locale": "en",
"path": "en",
"priceListId": null
},
"storefrontTheme": {
"id": "69b1451f-3467-4c7b-8ce1-bf4fec8400f8",
"name": "test 6",
"themeId": "84a89e25-9826-4b65-b056-6cb98cfb318e",
"themeVersionId": "9da2385d-9fef-4066-8d3e-8377a5bf0e1b"
},
"taxLines": [],
"invoices": [],
"totalFinalPrice": 170.5,
"totalPrice": 299,
"updatedAt": 1638189270536,
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.55 Safari/537.36",
"isGiftPackage": false,
"giftPackageNote": null,
"giftPackageLines": null
}
]
}
}
}

Set Order Package Status as Ready for Shipment

curl --location --request POST 'https://api.myikas.com/api/v1/admin/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_access_token>' \
--data-raw '{"query":"mutation { updateOrderPackageStatus( input: { orderId: \"84ffbfd2-c92c-4f22-9675-8d3edb7a9084\" packages: [ { packageId:\"a103735c-ece8-4a8f-9576-489f45c4487b\" status: READY_FOR_SHIPMENT trackingInfo: { barcode: \"123456\" cargoCompany: \"UPS\" trackingNumber: \"123456\" } } ] } ) {billingAddress { addressLine1 addressLine2 city { code id name } company country { code id iso2 iso3 name } district { code id name } firstName id identityNumber isDefault lastName phone postalCode state { code id name } taxNumber taxOffice } branch { id name } branchSessionId cancelReason cancelledAt clientIp createdAt currencyCode currencyRates { code originalRate rate } customer { email firstName id identityNumber isGuestCheckout lastName phone } deleted giftPackageLines { price taxValue } giftPackageNote host id invoices { appId appName createdAt id invoiceNumber storeAppId type } isGiftPackage merchantId note orderAdjustments { amount amountType appliedOrderLines { amount appliedQuantity orderLineId } campaignId couponId name order type } orderLineItems { createdAt currencyCode deleted discount { amount amountType reason } discountPrice finalPrice id options { name productOptionId productOptionsSetId type values { name price value } } originalOrderLineItemId price quantity status statusUpdatedAt stockLocationId taxValue updatedAt variant { barcodeList brand { id name } categories { categoryPath { id name } id name } id mainImageId name prices { buyPrice currency discountPrice priceListId sellPrice } productId sku slug tagIds taxValue type variantValues { order variantTypeId variantTypeName variantValueId variantValueName } } } orderNumber orderPackageSequence orderPackageStatus orderPackages { createdAt deleted errorMessage id note orderLineItemIds orderPackageFulfillStatus orderPackageNumber stockLocationId trackingInfo { barcode cargoCompany isSendNotification trackingLink trackingNumber } updatedAt } orderPaymentStatus orderSequence orderTagIds orderedAt paymentMethods { price type } priceList { id name } salesChannel { id name type } shippingAddress { addressLine1 addressLine2 city { code id name } company country { code id iso2 iso3 name } district { code id name } firstName id identityNumber isDefault lastName phone postalCode state { code id name } taxNumber taxOffice } shippingLines { isRefunded price shippingSettingsId shippingZoneRateId taxValue title } shippingMethod staff { email firstName lastName } status storefront { id name } storefrontRouting { domain id locale path priceListId } storefrontTheme { id name themeId themeVersionId } taxLines { price rate } terminalId totalFinalPrice totalPrice updatedAt userAgent} }"}'

Response

{
"data": {
"updateOrderPackageStatus": {
"billingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"cancelReason": null,
"cancelledAt": null,
"clientIp": "176.42.29.28",
"createdAt": 1637759203328,
"currencyCode": "TRY",
"currencyRates": [],
"customer": {
"email": "ikas@ikas.com",
"firstName": "ikas",
"id": "fa8b6fbc-210d-4488-88ab-a7bea0a2648b",
"identityNumber": null,
"lastName": "docs",
"phone": null
},
"deleted": false,
"host": "apidocs.myikas.dev",
"id": "84ffbfd2-c92c-4f22-9675-8d3edb7a9084",
"merchantId": "75d8a449-2feb-4230-9eb4-9014673324d5",
"note": null,
"orderAdjustments": [
{
"amount": 149.5,
"amountType": "AMOUNT",
"campaignId": "653aa7c2-4d3c-42ba-aba9-94060f52660d",
"couponId": null,
"name": "Kargo Bypass",
"order": 1,
"type": "DECREMENT"
}
],
"orderLineItems": [
{
"createdAt": 1638189270536,
"currencyCode": "TRY",
"deleted": false,
"discount": null,
"discountPrice": null,
"finalPrice": 149.5,
"id": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"originalOrderLineItemId": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"price": 299,
"quantity": 1,
"status": "FULFILLED",
"statusUpdatedAt": null,
"stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
"taxValue": null,
"updatedAt": 1638189270536,
"variant": {
"barcodeList": [],
"id": "bd9b2bd8-0110-4ded-84c0-b8298332e469",
"mainImageId": "e047ce73-8b77-40f0-8f13-eff9c2b05f4f",
"name": "ikas Ürünü Siyah Kılıf - iPhone 11 Pro Max Kılıf Silikon",
"productId": "62bca022-12be-4e2b-a9dd-90c67cb89dcb",
"sku": null,
"slug": "ikas-urunu-siyah-kilif-iphone-11-pro-max-kilif-silikon",
"tagIds": [],
"taxValue": null,
"variantValues": []
},
"options": []
}
],
"orderNumber": "1028",
"orderPackageStatus": "FULFILLED",
"orderPackages": [
{
"createdAt": 1638189270536,
"deleted": false,
"errorMessage": null,
"id": "a103735c-ece8-4a8f-9576-489f45c4487b",
"note": null,
"orderLineItemIds": ["0a6f539f-8338-400c-a3fc-2bc15c01da58"],
"orderPackageFulfillStatus": "FULFILLED",
"orderPackageNumber": "1028-1",
"stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
"trackingInfo": {
"barcode": "123456",
"cargoCompany": "UPS",
"isSendNotification": null,
"trackingLink": null,
"trackingNumber": "123456"
},
"updatedAt": 1638189270536
}
],
"orderPaymentStatus": "PAID",
"orderSequence": 28,
"orderTagIds": [],
"orderedAt": 1637759203143,
"paymentMethods": [
{
"price": 170.5,
"type": "MONEY_ORDER"
}
],
"priceList": null,
"salesChannel": {
"id": "9fa400f3-fbf1-4ee7-bc26-3cae7f9c3427",
"name": "Jack",
"type": 1
},
"shippingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"shippingLines": [
{
"price": 21,
"shippingSettingsId": "ee4cc76c-f0c3-469f-ab8e-cc14b17fe78c",
"shippingZoneRateId": "db02cc2d-5ba3-4b5b-8147-fee010faca21",
"taxValue": null,
"title": "Kkk",
"isRefunded": null
}
],
"shippingMethod": "SHIPMENT",
"status": "CREATED",
"storefront": {
"id": "8b742b03-c8f8-4509-858c-f9487c3701f2",
"name": "Jack"
},
"storefrontRouting": {
"domain": "tr",
"id": "d3d0b8d9-76c6-436b-a1ba-024c1f4f4a12",
"locale": "en",
"path": "en",
"priceListId": null
},
"storefrontTheme": {
"id": "69b1451f-3467-4c7b-8ce1-bf4fec8400f8",
"name": "test 6",
"themeId": "84a89e25-9826-4b65-b056-6cb98cfb318e",
"themeVersionId": "9da2385d-9fef-4066-8d3e-8377a5bf0e1b"
},
"taxLines": [],
"invoices": [],
"totalFinalPrice": 170.5,
"totalPrice": 299,
"updatedAt": 1638189270536,
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.55 Safari/537.36",
"isGiftPackage": false,
"giftPackageNote": null,
"giftPackageLines": null
}
}
}

Fulfill Order Lines with Tracking Info

curl --location --request POST 'https://api.myikas.com/api/v1/admin/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_access_token>' \
--data-raw '{"query":"mutationundefined"}'

Response

{
"data": {
"fulfillOrder": {
"billingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"cancelReason": null,
"cancelledAt": null,
"clientIp": "176.42.29.28",
"createdAt": 1637759203328,
"currencyCode": "TRY",
"currencyRates": [],
"customer": {
"email": "ikas@ikas.com",
"firstName": "ikas",
"id": "fa8b6fbc-210d-4488-88ab-a7bea0a2648b",
"identityNumber": null,
"lastName": "docs",
"phone": null
},
"deleted": false,
"host": "apidocs.myikas.dev",
"id": "84ffbfd2-c92c-4f22-9675-8d3edb7a9084",
"merchantId": "75d8a449-2feb-4230-9eb4-9014673324d5",
"note": null,
"orderAdjustments": [
{
"amount": 149.5,
"amountType": "AMOUNT",
"campaignId": "653aa7c2-4d3c-42ba-aba9-94060f52660d",
"couponId": null,
"name": "Kargo Bypass",
"order": 1,
"type": "DECREMENT"
}
],
"orderLineItems": [
{
"createdAt": 1638189270536,
"currencyCode": "TRY",
"deleted": false,
"discount": null,
"discountPrice": null,
"finalPrice": 149.5,
"id": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"originalOrderLineItemId": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"price": 299,
"quantity": 1,
"status": "FULFILLED",
"statusUpdatedAt": null,
"stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
"taxValue": null,
"updatedAt": 1638189270536,
"variant": {
"barcodeList": [],
"id": "bd9b2bd8-0110-4ded-84c0-b8298332e469",
"mainImageId": "e047ce73-8b77-40f0-8f13-eff9c2b05f4f",
"name": "ikas Ürünü Siyah Kılıf - iPhone 11 Pro Max Kılıf Silikon",
"productId": "62bca022-12be-4e2b-a9dd-90c67cb89dcb",
"sku": null,
"slug": "ikas-urunu-siyah-kilif-iphone-11-pro-max-kilif-silikon",
"tagIds": [],
"taxValue": null,
"variantValues": []
},
"options": []
}
],
"orderNumber": "1028",
"orderPackageStatus": "FULFILLED",
"orderPackages": [
{
"createdAt": 1638189270536,
"deleted": false,
"errorMessage": null,
"id": "a103735c-ece8-4a8f-9576-489f45c4487b",
"note": null,
"orderLineItemIds": ["0a6f539f-8338-400c-a3fc-2bc15c01da58"],
"orderPackageFulfillStatus": "FULFILLED",
"orderPackageNumber": "1028-1",
"stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
"trackingInfo": {
"barcode": "123456",
"cargoCompany": "UPS",
"isSendNotification": null,
"trackingLink": null,
"trackingNumber": "123456"
},
"updatedAt": 1638189270536
}
],
"orderPaymentStatus": "PAID",
"orderSequence": 28,
"orderTagIds": [],
"orderedAt": 1637759203143,
"paymentMethods": [
{
"price": 170.5,
"type": "MONEY_ORDER"
}
],
"priceList": null,
"salesChannel": {
"id": "9fa400f3-fbf1-4ee7-bc26-3cae7f9c3427",
"name": "Jack",
"type": 1
},
"shippingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"shippingLines": [
{
"price": 21,
"shippingSettingsId": "ee4cc76c-f0c3-469f-ab8e-cc14b17fe78c",
"shippingZoneRateId": "db02cc2d-5ba3-4b5b-8147-fee010faca21",
"taxValue": null,
"title": "Kkk",
"isRefunded": null
}
],
"shippingMethod": "SHIPMENT",
"status": "CREATED",
"storefront": {
"id": "8b742b03-c8f8-4509-858c-f9487c3701f2",
"name": "Jack"
},
"storefrontRouting": {
"domain": "tr",
"id": "d3d0b8d9-76c6-436b-a1ba-024c1f4f4a12",
"locale": "en",
"path": "en",
"priceListId": null
},
"storefrontTheme": {
"id": "69b1451f-3467-4c7b-8ce1-bf4fec8400f8",
"name": "test 6",
"themeId": "84a89e25-9826-4b65-b056-6cb98cfb318e",
"themeVersionId": "9da2385d-9fef-4066-8d3e-8377a5bf0e1b"
},
"taxLines": [],
"invoices": [],
"totalFinalPrice": 170.5,
"totalPrice": 299,
"updatedAt": 1638189270536,
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.55 Safari/537.36",
"isGiftPackage": false,
"giftPackageNote": null,
"giftPackageLines": null
}
}
}

Add Invoice PDF to Order

curl --location --request POST 'https://api.myikas.com/api/v1/admin/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_access_token>' \
--data-raw '{"query":"mutationundefined"}'

Response

{
"data": {
"addOrderInvoice": {
"billingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"cancelReason": null,
"cancelledAt": null,
"clientIp": "176.42.29.28",
"createdAt": 1637759203328,
"currencyCode": "TRY",
"currencyRates": [],
"customer": {
"email": "ikas@ikas.com",
"firstName": "ikas",
"id": "fa8b6fbc-210d-4488-88ab-a7bea0a2648b",
"identityNumber": null,
"lastName": "docs",
"phone": null
},
"deleted": false,
"host": "apidocs.myikas.dev",
"id": "84ffbfd2-c92c-4f22-9675-8d3edb7a9084",
"merchantId": "75d8a449-2feb-4230-9eb4-9014673324d5",
"note": null,
"orderAdjustments": [
{
"amount": 149.5,
"amountType": "AMOUNT",
"campaignId": "653aa7c2-4d3c-42ba-aba9-94060f52660d",
"couponId": null,
"name": "Kargo Bypass",
"order": 1,
"type": "DECREMENT"
}
],
"orderLineItems": [
{
"createdAt": 1638189270536,
"currencyCode": "TRY",
"deleted": false,
"discount": null,
"discountPrice": null,
"finalPrice": 149.5,
"id": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"originalOrderLineItemId": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"price": 299,
"quantity": 1,
"status": "FULFILLED",
"statusUpdatedAt": null,
"stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
"taxValue": null,
"updatedAt": 1638189270536,
"variant": {
"barcodeList": [],
"id": "bd9b2bd8-0110-4ded-84c0-b8298332e469",
"mainImageId": "e047ce73-8b77-40f0-8f13-eff9c2b05f4f",
"name": "ikas Ürünü Siyah Kılıf - iPhone 11 Pro Max Kılıf Silikon",
"productId": "62bca022-12be-4e2b-a9dd-90c67cb89dcb",
"sku": null,
"slug": "ikas-urunu-siyah-kilif-iphone-11-pro-max-kilif-silikon",
"tagIds": [],
"taxValue": null,
"variantValues": []
},
"options": []
}
],
"orderNumber": "1028",
"orderPackageStatus": "FULFILLED",
"orderPackages": [
{
"createdAt": 1638189270536,
"deleted": false,
"errorMessage": null,
"id": "a103735c-ece8-4a8f-9576-489f45c4487b",
"note": null,
"orderLineItemIds": ["0a6f539f-8338-400c-a3fc-2bc15c01da58"],
"orderPackageFulfillStatus": "FULFILLED",
"orderPackageNumber": "1028-1",
"stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
"trackingInfo": {
"barcode": "123456",
"cargoCompany": "UPS",
"isSendNotification": null,
"trackingLink": null,
"trackingNumber": "123456"
},
"updatedAt": 1638189270536
}
],
"orderPaymentStatus": "PAID",
"orderSequence": 28,
"orderTagIds": [],
"orderedAt": 1637759203143,
"paymentMethods": [
{
"price": 170.5,
"type": "MONEY_ORDER"
}
],
"priceList": null,
"salesChannel": {
"id": "9fa400f3-fbf1-4ee7-bc26-3cae7f9c3427",
"name": "Jack",
"type": 1
},
"shippingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"shippingLines": [
{
"price": 21,
"shippingSettingsId": "ee4cc76c-f0c3-469f-ab8e-cc14b17fe78c",
"shippingZoneRateId": "db02cc2d-5ba3-4b5b-8147-fee010faca21",
"taxValue": null,
"title": "Kkk",
"isRefunded": null
}
],
"shippingMethod": "SHIPMENT",
"status": "CREATED",
"storefront": {
"id": "8b742b03-c8f8-4509-858c-f9487c3701f2",
"name": "Jack"
},
"storefrontRouting": {
"domain": "tr",
"id": "d3d0b8d9-76c6-436b-a1ba-024c1f4f4a12",
"locale": "en",
"path": "en",
"priceListId": null
},
"storefrontTheme": {
"id": "69b1451f-3467-4c7b-8ce1-bf4fec8400f8",
"name": "test 6",
"themeId": "84a89e25-9826-4b65-b056-6cb98cfb318e",
"themeVersionId": "9da2385d-9fef-4066-8d3e-8377a5bf0e1b"
},
"taxLines": [],
"invoices": [
{
"appId": "1a3456a8-5119-11ec-bf63-0242ac130002",
"appName": "ikas-app",
"createdAt": "1638189270536",
"id": "97e39a32-5119-11ec-bf63-0242ac130002",
"invoiceNumber": "IK-10001-",
"storeAppId": "ddf74564-5119-11ec-bf63-0242ac130002",
"type": "COMPANY"
}
],
"totalFinalPrice": 170.5,
"totalPrice": 299,
"updatedAt": 1638189270536,
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.55 Safari/537.36",
"isGiftPackage": false,
"giftPackageNote": null,
"giftPackageLines": null
}
}
}

Create New Order With Transaction Data

curl --location --request POST 'https://api.myikas.com/api/v1/admin/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_access_token>' \
--data-raw '{"query":"mutationundefined"}'

Response

{
"data": {
"addOrderInvoice": {
"billingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"cancelReason": null,
"cancelledAt": null,
"clientIp": "176.42.29.28",
"createdAt": 1637759203328,
"currencyCode": "TRY",
"currencyRates": [],
"customer": {
"email": "ikas@ikas.com",
"firstName": "ikas",
"id": "fa8b6fbc-210d-4488-88ab-a7bea0a2648b",
"identityNumber": null,
"lastName": "docs",
"phone": null
},
"deleted": false,
"host": "apidocs.myikas.dev",
"id": "84ffbfd2-c92c-4f22-9675-8d3edb7a9084",
"merchantId": "75d8a449-2feb-4230-9eb4-9014673324d5",
"note": null,
"orderAdjustments": [
{
"amount": 149.5,
"amountType": "AMOUNT",
"campaignId": "653aa7c2-4d3c-42ba-aba9-94060f52660d",
"couponId": null,
"name": "Kargo Bypass",
"order": 1,
"type": "DECREMENT"
}
],
"orderLineItems": [
{
"createdAt": 1638189270536,
"currencyCode": "TRY",
"deleted": false,
"discount": null,
"discountPrice": null,
"finalPrice": 149.5,
"id": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"originalOrderLineItemId": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"price": 299,
"quantity": 1,
"status": "FULFILLED",
"statusUpdatedAt": null,
"stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
"taxValue": null,
"updatedAt": 1638189270536,
"variant": {
"barcodeList": [],
"id": "bd9b2bd8-0110-4ded-84c0-b8298332e469",
"mainImageId": "e047ce73-8b77-40f0-8f13-eff9c2b05f4f",
"name": "ikas Ürünü Siyah Kılıf - iPhone 11 Pro Max Kılıf Silikon",
"productId": "62bca022-12be-4e2b-a9dd-90c67cb89dcb",
"sku": null,
"slug": "ikas-urunu-siyah-kilif-iphone-11-pro-max-kilif-silikon",
"tagIds": [],
"taxValue": null,
"variantValues": []
},
"options": []
}
],
"orderNumber": "1028",
"orderPackageStatus": "FULFILLED",
"orderPackages": [
{
"createdAt": 1638189270536,
"deleted": false,
"errorMessage": null,
"id": "a103735c-ece8-4a8f-9576-489f45c4487b",
"note": null,
"orderLineItemIds": ["0a6f539f-8338-400c-a3fc-2bc15c01da58"],
"orderPackageFulfillStatus": "FULFILLED",
"orderPackageNumber": "1028-1",
"stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
"trackingInfo": {
"barcode": "123456",
"cargoCompany": "UPS",
"isSendNotification": null,
"trackingLink": null,
"trackingNumber": "123456"
},
"updatedAt": 1638189270536
}
],
"orderPaymentStatus": "PAID",
"orderSequence": 28,
"orderTagIds": [],
"orderedAt": 1637759203143,
"paymentMethods": [
{
"price": 170.5,
"type": "MONEY_ORDER"
}
],
"priceList": null,
"salesChannel": {
"id": "9fa400f3-fbf1-4ee7-bc26-3cae7f9c3427",
"name": "Jack",
"type": 1
},
"shippingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"shippingLines": [
{
"price": 21,
"shippingSettingsId": "ee4cc76c-f0c3-469f-ab8e-cc14b17fe78c",
"shippingZoneRateId": "db02cc2d-5ba3-4b5b-8147-fee010faca21",
"taxValue": null,
"title": "Kkk",
"isRefunded": null
}
],
"shippingMethod": "SHIPMENT",
"status": "CREATED",
"storefront": {
"id": "8b742b03-c8f8-4509-858c-f9487c3701f2",
"name": "Jack"
},
"storefrontRouting": {
"domain": "tr",
"id": "d3d0b8d9-76c6-436b-a1ba-024c1f4f4a12",
"locale": "en",
"path": "en",
"priceListId": null
},
"storefrontTheme": {
"id": "69b1451f-3467-4c7b-8ce1-bf4fec8400f8",
"name": "test 6",
"themeId": "84a89e25-9826-4b65-b056-6cb98cfb318e",
"themeVersionId": "9da2385d-9fef-4066-8d3e-8377a5bf0e1b"
},
"taxLines": [],
"invoices": [
{
"appId": "1a3456a8-5119-11ec-bf63-0242ac130002",
"appName": "ikas-app",
"createdAt": "1638189270536",
"id": "97e39a32-5119-11ec-bf63-0242ac130002",
"invoiceNumber": "IK-10001-",
"storeAppId": "ddf74564-5119-11ec-bf63-0242ac130002",
"type": "COMPANY"
}
],
"totalFinalPrice": 170.5,
"totalPrice": 299,
"updatedAt": 1638189270536,
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.55 Safari/537.36",
"isGiftPackage": false,
"giftPackageNote": null,
"giftPackageLines": null
}
}
}

Cancel Fulfilled Package

curl --location --request POST 'https://api.myikas.com/api/v1/admin/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_access_token>' \
--data-raw '{"query":"mutationundefined"}'

Response

{
"data": {
"cancelfulfillment": {
"billingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"cancelReason": null,
"cancelledAt": null,
"clientIp": "176.42.29.28",
"createdAt": 1637759203328,
"currencyCode": "TRY",
"currencyRates": [],
"customer": {
"email": "ikas@ikas.com",
"firstName": "ikas",
"id": "fa8b6fbc-210d-4488-88ab-a7bea0a2648b",
"identityNumber": null,
"lastName": "docs",
"phone": null
},
"deleted": false,
"host": "apidocs.myikas.dev",
"id": "84ffbfd2-c92c-4f22-9675-8d3edb7a9084",
"merchantId": "75d8a449-2feb-4230-9eb4-9014673324d5",
"note": null,
"orderAdjustments": [
{
"amount": 149.5,
"amountType": "AMOUNT",
"campaignId": "653aa7c2-4d3c-42ba-aba9-94060f52660d",
"couponId": null,
"name": "Kargo Bypass",
"order": 1,
"type": "DECREMENT"
}
],
"orderLineItems": [
{
"createdAt": 1638196461905,
"currencyCode": "TRY",
"deleted": false,
"discount": null,
"discountPrice": null,
"finalPrice": 149.5,
"id": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"originalOrderLineItemId": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"price": 299,
"quantity": 1,
"status": "UNFULFILLED",
"statusUpdatedAt": null,
"stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
"taxValue": null,
"updatedAt": 1638196461905,
"variant": {
"barcodeList": [],
"id": "bd9b2bd8-0110-4ded-84c0-b8298332e469",
"mainImageId": "e047ce73-8b77-40f0-8f13-eff9c2b05f4f",
"name": "ikas Ürünü Siyah Kılıf - iPhone 11 Pro Max Kılıf Silikon",
"productId": "62bca022-12be-4e2b-a9dd-90c67cb89dcb",
"sku": null,
"slug": "ikas-urunu-siyah-kilif-iphone-11-pro-max-kilif-silikon",
"tagIds": [],
"taxValue": null,
"variantValues": []
},
"options": []
}
],
"orderNumber": "1028",
"orderPackageStatus": "UNFULFILLED",
"orderPackages": [],
"orderPaymentStatus": "PAID",
"orderSequence": 28,
"orderTagIds": [],
"orderedAt": 1637759203143,
"paymentMethods": [
{
"price": 170.5,
"type": "MONEY_ORDER"
}
],
"priceList": null,
"salesChannel": {
"id": "9fa400f3-fbf1-4ee7-bc26-3cae7f9c3427",
"name": "Jack",
"type": 1
},
"shippingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"shippingLines": [
{
"price": 21,
"shippingSettingsId": "ee4cc76c-f0c3-469f-ab8e-cc14b17fe78c",
"shippingZoneRateId": "db02cc2d-5ba3-4b5b-8147-fee010faca21",
"taxValue": null,
"title": "Kkk",
"isRefunded": null
}
],
"shippingMethod": "SHIPMENT",
"status": "CREATED",
"storefront": {
"id": "8b742b03-c8f8-4509-858c-f9487c3701f2",
"name": "Jack"
},
"storefrontRouting": {
"domain": "tr",
"id": "d3d0b8d9-76c6-436b-a1ba-024c1f4f4a12",
"locale": "en",
"path": "en",
"priceListId": null
},
"storefrontTheme": {
"id": "69b1451f-3467-4c7b-8ce1-bf4fec8400f8",
"name": "test 6",
"themeId": "84a89e25-9826-4b65-b056-6cb98cfb318e",
"themeVersionId": "9da2385d-9fef-4066-8d3e-8377a5bf0e1b"
},
"taxLines": [],
"invoices": [],
"totalFinalPrice": 170.5,
"totalPrice": 299,
"updatedAt": 1638196461905,
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.55 Safari/537.36",
"isGiftPackage": false,
"giftPackageNote": null,
"giftPackageLines": null
}
}
}

Update Order Line Item

curl --location --request POST 'https://api.myikas.com/api/v1/admin/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_access_token>' \
--data-raw '{"query":"mutationundefined"}'

Response

{
"data": {
"updateOrderLine": {
"billingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"cancelReason": null,
"cancelledAt": null,
"clientIp": "176.42.29.28",
"createdAt": 1637759203328,
"currencyCode": "TRY",
"currencyRates": [],
"customer": {
"email": "ikas@ikas.com",
"firstName": "ikas",
"id": "fa8b6fbc-210d-4488-88ab-a7bea0a2648b",
"identityNumber": null,
"lastName": "docs",
"phone": null
},
"deleted": false,
"host": "apidocs.myikas.dev",
"id": "84ffbfd2-c92c-4f22-9675-8d3edb7a9084",
"merchantId": "75d8a449-2feb-4230-9eb4-9014673324d5",
"note": null,
"orderAdjustments": [
{
"amount": 149.5,
"amountType": "AMOUNT",
"campaignId": "653aa7c2-4d3c-42ba-aba9-94060f52660d",
"couponId": null,
"name": "Kargo Bypass",
"order": 1,
"type": "DECREMENT"
}
],
"orderLineItems": [
{
"createdAt": 1638196461905,
"currencyCode": "TRY",
"deleted": false,
"discount": null,
"discountPrice": null,
"finalPrice": 149.5,
"id": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"originalOrderLineItemId": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"price": 299,
"quantity": 1,
"status": "UNFULFILLED",
"statusUpdatedAt": null,
"stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
"taxValue": null,
"updatedAt": 1638196461905,
"variant": {
"barcodeList": [],
"id": "bd9b2bd8-0110-4ded-84c0-b8298332e469",
"mainImageId": "e047ce73-8b77-40f0-8f13-eff9c2b05f4f",
"name": "ikas Ürünü Siyah Kılıf - iPhone 11 Pro Max Kılıf Silikon",
"productId": "62bca022-12be-4e2b-a9dd-90c67cb89dcb",
"sku": null,
"slug": "ikas-urunu-siyah-kilif-iphone-11-pro-max-kilif-silikon",
"tagIds": [],
"taxValue": null,
"variantValues": []
},
"options": []
}
],
"orderNumber": "1028",
"orderPackageStatus": "UNFULFILLED",
"orderPackages": [],
"orderPaymentStatus": "PAID",
"orderSequence": 28,
"orderTagIds": [],
"orderedAt": 1637759203143,
"paymentMethods": [
{
"price": 170.5,
"type": "MONEY_ORDER"
}
],
"priceList": null,
"salesChannel": {
"id": "9fa400f3-fbf1-4ee7-bc26-3cae7f9c3427",
"name": "Jack",
"type": 1
},
"shippingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"shippingLines": [
{
"price": 21,
"shippingSettingsId": "ee4cc76c-f0c3-469f-ab8e-cc14b17fe78c",
"shippingZoneRateId": "db02cc2d-5ba3-4b5b-8147-fee010faca21",
"taxValue": null,
"title": "Kkk",
"isRefunded": null
}
],
"shippingMethod": "SHIPMENT",
"status": "CREATED",
"storefront": {
"id": "8b742b03-c8f8-4509-858c-f9487c3701f2",
"name": "Jack"
},
"storefrontRouting": {
"domain": "tr",
"id": "d3d0b8d9-76c6-436b-a1ba-024c1f4f4a12",
"locale": "en",
"path": "en",
"priceListId": null
},
"storefrontTheme": {
"id": "69b1451f-3467-4c7b-8ce1-bf4fec8400f8",
"name": "test 6",
"themeId": "84a89e25-9826-4b65-b056-6cb98cfb318e",
"themeVersionId": "9da2385d-9fef-4066-8d3e-8377a5bf0e1b"
},
"taxLines": [],
"invoices": [],
"totalFinalPrice": 170.5,
"totalPrice": 299,
"updatedAt": 1638196461905,
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.55 Safari/537.36",
"isGiftPackage": false,
"giftPackageNote": null,
"giftPackageLines": null
}
}
}

Update Order Billing Address

curl --location --request POST 'https://api.myikas.com/api/v1/admin/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_access_token>' \
--data-raw '{"query":"mutationundefined"}'

Response

{
"data": {
"updateOrderAddresses": {
"billingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": "111111111111",
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"cancelReason": null,
"cancelledAt": null,
"clientIp": "176.42.29.28",
"createdAt": 1637759203328,
"currencyCode": "TRY",
"currencyRates": [],
"customer": {
"email": "ikas@ikas.com",
"firstName": "ikas",
"id": "fa8b6fbc-210d-4488-88ab-a7bea0a2648b",
"identityNumber": null,
"lastName": "docs",
"phone": null
},
"deleted": false,
"host": "apidocs.myikas.dev",
"id": "84ffbfd2-c92c-4f22-9675-8d3edb7a9084",
"merchantId": "75d8a449-2feb-4230-9eb4-9014673324d5",
"note": null,
"orderAdjustments": [
{
"amount": 149.5,
"amountType": "AMOUNT",
"campaignId": "653aa7c2-4d3c-42ba-aba9-94060f52660d",
"couponId": null,
"name": "Kargo Bypass",
"order": 1,
"type": "DECREMENT"
}
],
"orderLineItems": [
{
"createdAt": 1638196461905,
"currencyCode": "TRY",
"deleted": false,
"discount": null,
"discountPrice": null,
"finalPrice": 149.5,
"id": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"originalOrderLineItemId": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"price": 299,
"quantity": 1,
"status": "UNFULFILLED",
"statusUpdatedAt": null,
"stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
"taxValue": null,
"updatedAt": 1638196461905,
"variant": {
"barcodeList": [],
"id": "bd9b2bd8-0110-4ded-84c0-b8298332e469",
"mainImageId": "e047ce73-8b77-40f0-8f13-eff9c2b05f4f",
"name": "ikas Ürünü Siyah Kılıf - iPhone 11 Pro Max Kılıf Silikon",
"productId": "62bca022-12be-4e2b-a9dd-90c67cb89dcb",
"sku": null,
"slug": "ikas-urunu-siyah-kilif-iphone-11-pro-max-kilif-silikon",
"tagIds": [],
"taxValue": null,
"variantValues": []
},
"options": []
}
],
"orderNumber": "1028",
"orderPackageStatus": "UNFULFILLED",
"orderPackages": [],
"orderPaymentStatus": "PAID",
"orderSequence": 28,
"orderTagIds": [],
"orderedAt": 1637759203143,
"paymentMethods": [
{
"price": 170.5,
"type": "MONEY_ORDER"
}
],
"priceList": null,
"salesChannel": {
"id": "9fa400f3-fbf1-4ee7-bc26-3cae7f9c3427",
"name": "Jack",
"type": 1
},
"shippingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"shippingLines": [
{
"price": 21,
"shippingSettingsId": "ee4cc76c-f0c3-469f-ab8e-cc14b17fe78c",
"shippingZoneRateId": "db02cc2d-5ba3-4b5b-8147-fee010faca21",
"taxValue": null,
"title": "Kkk",
"isRefunded": null
}
],
"shippingMethod": "SHIPMENT",
"status": "CREATED",
"storefront": {
"id": "8b742b03-c8f8-4509-858c-f9487c3701f2",
"name": "Jack"
},
"storefrontRouting": {
"domain": "tr",
"id": "d3d0b8d9-76c6-436b-a1ba-024c1f4f4a12",
"locale": "en",
"path": "en",
"priceListId": null
},
"storefrontTheme": {
"id": "69b1451f-3467-4c7b-8ce1-bf4fec8400f8",
"name": "test 6",
"themeId": "84a89e25-9826-4b65-b056-6cb98cfb318e",
"themeVersionId": "9da2385d-9fef-4066-8d3e-8377a5bf0e1b"
},
"taxLines": [],
"invoices": [],
"totalFinalPrice": 170.5,
"totalPrice": 299,
"updatedAt": 1638196461905,
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.55 Safari/537.36",
"isGiftPackage": false,
"giftPackageNote": null,
"giftPackageLines": null
}
}
}

Refund Order Line Item

curl --location --request POST 'https://api.myikas.com/api/v1/admin/graphql' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your_access_token>' \
--data-raw '{"query":"mutationundefined"}'

Response

{
"data": {
"updateOrderAddresses": {
"billingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": null,
"isDefault": false,
"lastName": "docs",
"phone": "+905386405353",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"cancelReason": null,
"cancelledAt": null,
"clientIp": "176.42.29.28",
"createdAt": 1637759203328,
"currencyCode": "TRY",
"currencyRates": [],
"customer": {
"email": "ikas@ikas.com",
"firstName": "ikas",
"id": "fa8b6fbc-210d-4488-88ab-a7bea0a2648b",
"identityNumber": null,
"lastName": "docs",
"phone": null
},
"deleted": false,
"host": "apidocs.myikas.dev",
"id": "84ffbfd2-c92c-4f22-9675-8d3edb7a9084",
"merchantId": "75d8a449-2feb-4230-9eb4-9014673324d5",
"note": null,
"orderAdjustments": [
{
"amount": 149.5,
"amountType": "AMOUNT",
"campaignId": "653aa7c2-4d3c-42ba-aba9-94060f52660d",
"couponId": null,
"name": "Kargo Bypass",
"order": 1,
"type": "DECREMENT"
}
],
"orderLineItems": [
{
"createdAt": 1638198123416,
"currencyCode": "TRY",
"deleted": false,
"discount": null,
"discountPrice": null,
"finalPrice": 149.5,
"id": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"originalOrderLineItemId": "0a6f539f-8338-400c-a3fc-2bc15c01da58",
"price": 299,
"quantity": 1,
"status": "REFUNDED",
"statusUpdatedAt": null,
"stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
"taxValue": null,
"updatedAt": 1638198123416,
"variant": {
"barcodeList": [],
"id": "bd9b2bd8-0110-4ded-84c0-b8298332e469",
"mainImageId": "e047ce73-8b77-40f0-8f13-eff9c2b05f4f",
"name": "ikas Ürünü Siyah Kılıf - iPhone 11 Pro Max Kılıf Silikon",
"productId": "62bca022-12be-4e2b-a9dd-90c67cb89dcb",
"sku": null,
"slug": "ikas-urunu-siyah-kilif-iphone-11-pro-max-kilif-silikon",
"tagIds": [],
"taxValue": null,
"variantValues": []
},
"options": []
}
],
"orderNumber": "1028",
"orderPackageStatus": "REFUNDED",
"orderPackages": [
{
"createdAt": 1638198123416,
"deleted": false,
"errorMessage": null,
"id": "f738798f-22fe-4267-b696-3685a9706ada",
"note": "asdsd",
"orderLineItemIds": [
"0a6f539f-8338-400c-a3fc-2bc15c01da58"
],
"orderPackageFulfillStatus": "REFUNDED",
"orderPackageNumber": "1028-3",
"stockLocationId": "a0d19a13-7603-4d75-9ed7-dc414b1df8df",
"trackingInfo": null,
"updatedAt": 1638198123416
}
],
"orderPaymentStatus": "PAID",
"orderSequence": 28,
"orderTagIds": [],
"orderedAt": 1637759203143,
"paymentMethods": [
{
"price": 170.5,
"type": "MONEY_ORDER"
}
],
"priceList": null,
"salesChannel": {
"id": "9fa400f3-fbf1-4ee7-bc26-3cae7f9c3427",
"name": "Jack",
"type": 1
},
"shippingAddress": {
"addressLine1": "ikas A.Ş. Koru Mah. Ahmet Taner Kışlalı Cad. No:4/12 North Star İş Merkezi",
"addressLine2": null,
"city": {
"code": null,
"id": "6f9272a3-9924-4223-baf8-9b21c9360f0c",
"name": "Ankara"
},
"company": null,
"country": {
"code": "TUR",
"id": "da8c5f2a-8d37-48a8-beff-6ab3793a1861",
"name": "Turkey"
},
"district": {
"code": null,
"id": "0774fbd3-b818-463a-b697-2e28a8a6daed",
"name": "Çankaya"
},
"firstName": "ikas",
"identityNumber": "11111111111",
"isDefault": false,
"lastName": "docs",
"phone": "+905555555555",
"postalCode": null,
"state": {
"code": null,
"id": "dcb9135c-4b84-4c06-9a42-f359317a9b78",
"name": "Default"
},
"taxNumber": null,
"taxOffice": null
},
"shippingLines": [
{
"price": 21,
"shippingSettingsId": "ee4cc76c-f0c3-469f-ab8e-cc14b17fe78c",
"shippingZoneRateId": "db02cc2d-5ba3-4b5b-8147-fee010faca21",
"taxValue": null,
"title": "Kkk",
"isRefunded": true
}
],
"shippingMethod": "SHIPMENT",
"status": "REFUNDED",
"storefront": {
"id": "8b742b03-c8f8-4509-858c-f9487c3701f2",
"name": "Jack"
},
"storefrontRouting": {
"domain": "tr",
"id": "d3d0b8d9-76c6-436b-a1ba-024c1f4f4a12",
"locale": "en",
"path": "en",
"priceListId": null
},
"storefrontTheme": {
"id": "69b1451f-3467-4c7b-8ce1-bf4fec8400f8",
"name": "test 6",
"themeId": "84a89e25-9826-4b65-b056-6cb98cfb318e",
"themeVersionId": "9da2385d-9fef-4066-8d3e-8377a5bf0e1b"
},
"taxLines": [],
"invoices": [],
"totalFinalPrice": 170.5,
"totalPrice": 299,
"updatedAt": 1638198123416,
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.55 Safari/537.36",
"isGiftPackage": false,
"giftPackageNote": null,
"giftPackageLines": null
}
}
}
}