Create/Update Store Settings

POST 
/store/store-setting

Create or update store settings by altId and altType.

Request

application/json

application/json

Body

Bodyrequired

altIdstringrequired

Location Id or Agency Id

altTypestringrequired
Available optionslocation
shippingOriginobjectrequired

Shipping origin address

storeOrderNotificationobject

Store order notification email

storeOrderFulfillmentNotificationobject

Store order fulfillment notification email

Example (auto)

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "shippingOrigin": {
    "name": "ABC Store",
    "country": "US",
    "state": "VA",
    "city": "Tokyo",
    "street1": "Street 1",
    "street2": "Street 2",
    "zip": "674561",
    "phone": "+1-214-559-6993",
    "email": "[email protected]"
  },
  "storeOrderNotification": {
    "enabled": true,
    "subject": "Your order is placed !",
    "emailTemplateId": "6788d542f0462ffd6bc29bb9",
    "defaultEmailTemplateId": "6788d542f0462ffd6bc29bb9"
  },
  "storeOrderFulfillmentNotification": {
    "enabled": true,
    "subject": "Order fulfilled",
    "emailTemplateId": "6788d542f0462ffd6bc29bb9",
    "defaultEmailTemplateId": "6788d542f0462ffd6bc29bb9"
  }
}

application/json

Successful response

application/json

Schema

Schema

statusbooleanrequired

Status of api action

messagestring

Success message

dataobjectrequired

Shipping carrier data

Example (auto)

{
  "status": true,
  "message": "Successfully created",
  "data": {
    "altId": "6578278e879ad2646715ba9c",
    "altType": "location",
    "shippingOrigin": {
      "name": "ABC Store",
      "country": "US",
      "state": "VA",
      "city": "Tokyo",
      "street1": "Street 1",
      "street2": "Street 2",
      "zip": "674561",
      "phone": "+1-214-559-6993",
      "email": "[email protected]"
    },
    "storeOrderNotification": {
      "enabled": true,
      "subject": "Your order is placed !",
      "emailTemplateId": "6788d542f0462ffd6bc29bb9",
      "defaultEmailTemplateId": "6788d542f0462ffd6bc29bb9"
    },
    "storeOrderFulfillmentNotification": {
      "enabled": true,
      "subject": "Order fulfilled",
      "emailTemplateId": "6788d542f0462ffd6bc29bb9",
      "defaultEmailTemplateId": "6788d542f0462ffd6bc29bb9"
    },
    "_id": "655b33a82209e60b6adb87a5",
    "createdAt": "2023-12-12T09:27:42.355Z",
    "updatedAt": "2023-12-12T09:27:42.355Z"
  }
}