Set Custom Address - Minted Connect

Request

Authorization

Provide your encrypted digest scheme data in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Digest username=guest, realm="test", nonce="2", uri="/uri", response="***"

Header Params

x-client-id

string

required

Default value: web

Default:

web

api-version

string

optional

Latest version: 3

Default:

3

Accept-Language

string

optional

Default:

tr

Body Params application/json

external_customer_id

string

required

>= 1 characters<= 110 characters

cart_token

string

required

shipping

object (Shipping Address)

required

id

number

optional

external_id

string | null

optional

Your custom external id

>= 1 characters<= 110 characters

tax_number

string

required

Idendity Number

fullname

string

required

phone

string

required

city

string

required

county

string

required

district

string

required

address

string

required

zipcode

string | null

optional

>= 0 characters<= 5 characters

street

string | null

optional

billing

object (Billing Address)

required

external_id

string | null

optional

>= 1 characters<= 110 characters

invoice_type

enum<string>

optional

Allowed values:

IndividualCorporate

fullname

string | null

optional

Required for Individual addresses

company_name

string | null

optional

Required for Corporate billing addresses

phone

string

required

email

string <email> | null

optional

city

string

required

county

string

required

district

string

required

address

string

required

Full address

zipcode

string | null

optional

<= 5 characters

street

string

optional

tax_office

string

optional

Required for Corporate billing addresses

tax_number

string

required

Identity number / Tax no

card_bin

string

optional

>= 6 characters<= 6 characters

Example

{
  "external_customer_id": "{{external_customer_id}}",
  "cart_token": "{{cart_token}}",
  "card_bin": "535616",
  "shipping": {
    "external_id": "optional",
    "city": "İstanbul",
    "county": "Beykoz",
    "district": "Acarlar Mah.",
    "street": "Sokak adı",
    "address": "54 sok. No: 12"
  },
  "billing": {
    "external_id": "optional-1",
    "invoice_type": "Individual",
    "company_name": "",
    "email": "[email protected]",
    "phone": "+905551112233",
    "city": "İstanbul",
    "county": "Beykoz",
    "district": "Acarlar Mah.",
    "street": "Sokak adı",
    "address": "54 sok. No: 13",
    "tax_number": "2838293932",
    "tax_office": ""
  }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PATCH 'https://api.staging.mintedconnect.com/partner/ecom/basket/setaddress' \
--header 'x-client-id;' \
--header 'api-version: 3' \
--header 'Accept-Language: tr' \
--header 'Content-Type: application/json' \
--data-raw '{
    "external_customer_id": "MTD0018232",
    "cart_token": "{{cart_token}}",
    "card_bin": "535616",
    "shipping": {
        "external_id":"optional",
        "city": "İstanbul",
        "county": "Beykoz",
        "district": "Acarlar Mah.",
        "street": "Sokak adı",
        "address": "54 sok. No: 12"
    },
    "billing": {
        "external_id":"optional-1",
        "invoice_type": "Individual",
        "company_name": "",
        "email": "[email protected]",
        "phone": "+905551112233",
        "city": "İstanbul",
        "county": "Beykoz",
        "district": "Acarlar Mah.",
        "street": "Sokak adı",
        "address": "54 sok. No: 13",
        "tax_number": "2838293932",
        "tax_office":""
    }
}'

Responses

🟢200OK

application/json

Body

data

object (Ecom Order)

required

pricefix

object

required

id

integer

required

guid

string

required

order_creation_status

enum<string>

required

Allowed values:

basketorder

token

string

required

external_id

string | null

optional

>= 1 characters<= 110 characters

increment_id

string

required

>= 16 characters<= 16 characters

price

number

required

tax

number

required

total

number

required

delivery_price

number

required

insurance_price

number

required

market_commission

number

required

minted_markup_price

number

required

silver_craftsmanship

number

required

paid_total

number

required

currency_rate

number

optional

currency_total

number

optional

status_id

integer

required

status_name

enum<string>

required

Allowed values:

PendingProcessingCancelledCompletedPreparingPackedShippedTransferringRefundingRefundedPayment Confirmed

delivery

object | null

optional

order_at

string <date-time>

required

Example:

2024-07-19T09:39:03.000000Z

payment_cost

number

required

items

array[object (Ecom OrderItem) {13}]

optional

customer

object (Order customer schema)

required

shippingaddress

optional

billingaddress

optional

payment

required

success

boolean

required

code

integer

required

message

string

required

Example

{
  "data": {
    "pricefix": {
      "remaining": -2,
      "nextUpdate": "2024-08-08T12:15:11+03:00"
    },
    "id": 291,
    "order_creation_status": "basket",
    "external_id": null,
    "increment_id": "MC_66C7446E7F53E",
    "token": "a7pVXOoOi0p3UZaHAF8Uyn6mzzS6QUh6",
    "price": 2921.03,
    "tax": 0,
    "delivery_price": 65,
    "insurance_price": 8.12,
    "total": 2921.03,
    "payment_cost": 0,
    "paid_total": 2921.03,
    "currency_code": "TRY",
    "status_id": 1,
    "status_name": "Created",
    "customer": {
      "external_id": "6679139d3df0004a8708fab5",
      "firstname": "John",
      "middlename": "",
      "lastname": "Due",
      "fullname": "John Due",
      "email": "[email protected]",
      "phone": "+905399322972",
      "gender": null,
      "identity_number": "",
      "birthdate": "0000-00-00"
    },
    "shippingaddress": {
      "id": 60,
      "type": "shipping",
      "invoice_type": "Individual",
      "company_name": "",
      "tax_office": "",
      "tax_number": "",
      "external_id": "optional",
      "fullname": "Hasan Uzuner",
      "phone": "+905399322972",
      "city": "İstanbul",
      "county": "Beykoz",
      "district": "Acarlar Mah.",
      "street": "Sokak adı",
      "zipcode": "",
      "address": "54 sok. No: 12"
    },
    "billingaddress": {
      "id": 59,
      "type": "billing",
      "invoice_type": "Individual",
      "company_name": "Minted LTD",
      "tax_office": "Beykoz",
      "tax_number": "2838293932",
      "external_id": "optional-1",
      "fullname": "John Due",
      "email": "[email protected]",
      "phone": "+905399322972",
      "city": "İstanbul",
      "county": "Beykoz",
      "district": "Acarlar Mah.",
      "street": "Sokak adı",
      "zipcode": "",
      "address": "54 sok. No: 13"
    },
    "payment": null,
    "order_at": "2024-07-26T23:46:26.000000Z",
    "items": [
      {
        "item_currency_id": 1000006,
        "item_currency_name": "Physical Gold",
        "product_id": 3000065,
        "sku": "MNT0001",
        "product_name": "Minted 1 Gr 999,9 Külçe Altın (NadirGold)",
        "product_weight": 1.01,
        "price": 2921.03,
        "tax_rate": 0,
        "tax": 0,
        "amount": 1,
        "total": 2921.03,
        "product_images": [
          "https://minted-tr.mncdn.com/products/10/Z1P5eT1ggOvmgyS5bwFeW1qZwS41zj5FOL3gu4Fv.png",
          "https://minted-tr.mncdn.com/products/10/JxMzuWaZkljzWoVXzfKZPWYY2FeAU1TQY1sAtMnv.png",
          "https://minted-tr.mncdn.com/products/10/qzyXgt51f7ndySM5QpMQqyDN6QBZXqAomsyshp5r.png",
          "https://minted-tr.mncdn.com/products/10/sKZiiWqLA9PdejL5mG2sMWOyPJl7FWD95ILsYtx4.png"
        ],
        "prices": [
          {
            "name": "Minted Markup",
            "price": 0
          },
          {
            "name": "Sigorta",
            "price": 5.45
          },
          {
            "name": "Kargo",
            "price": 0
          },
          {
            "name": "Market Komisyon",
            "price": 191.1
          }
        ]
      }
    ]
  },
  "success": true,
  "code": 0,
  "message": ""
}

🟠401Unauthorized

🟠404Record Not Found