1. Orders
Shanta API
  • Get Started
  • Authorization
  • Responses
  • Pagination
  • Rate Limiting
  • Languages
  • Support
  • APIs
    • Account balance
      • List balances
      • List transactions
      • List charges
      • Create charge
      • Create transfer
    • Affiliate marketers
      • Update affiliator status
    • Attachments
      • Delete attachment
    • Blog
      • Update blog topic image
      • Detach blog topic attachment
      • Update blog topic status
      • Update blog taxonomy status
    • Branches
      • Update branch
    • Brands
      • List brands
      • Update brand
    • Categories
      • List categories
      • Get category
    • Countries
      • List countries
      • List cities
    • Coupons
      • Update coupon status
    • Customer groups
      • List customer groups
      • Update customer group
    • Customers
      • List customers
      • Create customer
      • Get customer
      • Update customer
    • Marketing campaigns
      • Create campaign condition
      • Update campaign condition
      • Delete campaign condition
    • Notifications
      • List notifications
      • Mark all notifications as read
      • Read notification
      • Update notification setting status
    • Offers
      • Update cross selling offer status
      • Update up selling offer status
      • Update quantity discount status
    • Orders
      • Get orders stats
        GET
      • List orders
        GET
      • Create order
        POST
      • Get order
        GET
      • Update order
        PUT
      • Delete order
        DELETE
      • List order items
        GET
      • Update order status
        PATCH
      • Update allow to open package
        PATCH
      • Print order AWB
        POST
      • Cancel order
        POST
    • Page blocks
      • Get block catalog
    • Page templates
      • List templates
      • Get template
    • Pages
      • Update page status
      • Open draft
      • Update draft
      • Discard draft
      • Publish draft
      • List versions
      • Get version
      • Get version preview
      • Restore version
      • Apply template
      • Get block html
    • Payment methods
      • Bank accounts
        • Update bank account
      • Mobile wallet payments
        • Update digital wallet
      • Payment gateways
        • Update payment gateway
    • Product options
      • Update option value
      • Delete option value
      • List options
    • Products
      • List products
      • Create product
      • Get product
      • Update product
      • Delete product
      • Create product bulk action
      • Create write description draft
      • Create option
      • Update option
      • Delete option
      • Generate variants
      • Update variants
      • Detach product attachment
    • Referral program
      • Get my referral
      • Get my referral stats
      • List my referral commissions
      • List my referred users
      • Get my balance
      • List my withdrawals
      • Create my withdrawal
      • Cancel my withdrawal
    • Settings
      • List settings
      • Update settings
    • Shipments
      • List shipments
      • Create shipment
      • Update shipment
      • Cancel shipment
    • Shipping companies
      • List shipping companies
      • List delivery prices
      • Create delivery price
      • Update shipping company
    • Store features
      • Toggle website feature
      • Update feature data status
      • Verify facebook pixel
    • Support chat
      • List team
      • List conversations
      • Create conversation
      • Get conversation
      • List messages
      • Create message
      • Read mark conversation
      • List assistant messages
      • List setup steps
      • Create ask assistant
      • Create ask assistant
      • Create hand off conversation
      • Create rate assistant answer
    • Tags
      • List tags
    • Theme sections
      • List theme sections
      • Create theme section
      • Sort theme sections
      • Get theme section
      • Update theme section
    • Uploads
      • Upload
    • WhatsApp
      • List numbers
      • Create number
      • Get number status
      • List templates
      • Delete number
      • Create number pairing code
      • Set primary number
      • Update template
      • Update template status
  • Schemas
    • AddCartItemRequest
    • AddCrossSellRequest
    • AddWebsiteThemeSectionRequest
    • AdminNotificationResource
    • AiDraftResource
    • AppConfigResource
    • ApplyCouponRequest
    • ApplyQuantityDiscountRequest
    • AskAssistant
    • AuthCustomerResource
    • AuthUserResource
    • BalanceResource
    • BankAccountResource
    • BlockCatalogResource
    • BlockDefinitionResource
    • BlockResource
    • BookmarkResource
    • BranchResource
    • BrandResource
    • BulkActionProductsRequest
    • CartItemResource
    • CartResource
    • CartShippingOptionsResource
    • CategoryResource
    • ChargeInvoiceResource
    • CheckoutResultResource
    • CityResource
    • CodeSentResource
    • CompleteCheckoutRequest
    • ConversationResource
    • CountryResource
    • CustomerAddressResource
    • CustomerGroupResource
    • CustomerResource
    • CustomerSignInResource
    • DeliveryPriceResource
    • DigitalWalletResource
    • ForgotPasswordRequest
    • GuestTokenResource
    • HandOffConversation
    • InfoPageResource
    • LoginRequest
    • IssueResource
    • JoinedWebsiteResource
    • LandingPageResource
    • MessageResource
    • Modules.Core.Http.Requests.Website.Api.V1.SubscribePushNotificationsRequest
    • Modules.Customers.Http.Requests.Website.Api.V1.Auth.LoginRequest
    • NotifyAvailabilityRequest
    • OpenDraftRequest
    • OpenWebsiteRequest
    • OpenedWebsiteResource
    • OptionResource
    • OptionValueResource
    • OrderItemOptionResource
    • OrderItemResource
    • OrderResource
    • OrderShippingCompanyResource
    • OtpResultResource
    • PageResource
    • PatchDraftRequest
    • PaymentGatewayResource
    • PaymentMethodResource
    • PlatformCommissionResource
    • PlatformReferredUserResource
    • PlatformReferrerResource
    • PlatformUserBalanceResource
    • PlatformWithdrawalRequestResource
    • PreviewResource
    • PrintAwbRequest
    • ProductResource
    • QuickOrderRequest
    • RateAssistantAnswer
    • RegisterRequest
    • ResendOtpRequest
    • ReviewResource
    • SaveCartCustomerRequest
    • ServicePriceResource
    • SetupStepsResource
    • ShipmentResource
    • ShippingCompanyResource
    • ShippingOptionResource
    • SocialAuthRequest
    • SortWebsiteThemeSectionsRequest
    • StoreAddressRequest
    • StoreCampaignConditionRequest
    • StoreChargeRequest
    • StoreContactMessageRequest
    • StoreConversation
    • StoreCustomerRequest
    • StoreDeliveryPricesRequest
    • StoreFacebookEventRequest
    • StoreGoogleEventRequest
    • StoreIssueRequest
    • StoreMailList
    • StoreMessage
    • StoreOptionRequest
    • StoreOrderRequest
    • StoreProductRequest
    • StoreReviewRequest
    • StoreShipmentRequest
    • StoreThemeSectionRequest
    • StoreTiktokEventRequest
    • StoreTransferRequest
    • StoreWithdrawalRequest
    • SubscribePushNotificationsRequest
    • TagResource
    • TemplateResource
    • ThemeResource
    • ToggleWebsiteFeatureRequest
    • TopicResource
    • TrackingResource
    • TransactionResource
    • UpdateAddressRequest
    • UpdateAllowToOpenPackageRequest
    • UpdateShipmentRequest
    • UpdateBankAccountRequest
    • UpdateBranchRequest
    • UpdateBrandRequest
    • UpdateCampaignConditionRequest
    • UpdateCheckoutRequest
    • UpdateCustomerGroupRequest
    • UpdateCustomerRequest
    • UpdateDigitalWalletRequest
    • UpdateOptionRequest
    • UpdateOptionValueRequest
    • UpdateOrderRequest
    • UpdateOrderStatusRequest
    • UpdatePaymentGatewayRequest
    • UpdateProductRequest
    • UpdateProfileRequest
    • UpdateSettingsRequest
    • UpdateShippingCompanyRequest
    • UpdateStatusRequest
    • UpdateTopicSettingsRequest
    • UpdateUserRequest
    • UpdateVariantsRequest
    • UploadRequest
    • UserResource
    • UserSignInResource
    • VariantResource
    • VerifyFacebookPixelRequest
    • VerifyLoginCodeRequest
    • VerifyOtpRequest
    • WebsiteProductResource
    • WebsiteVariantResource
    • WhatsappConnectionResource
    • WhatsappPairingCodeRequest
    • WriteDescriptionDraftRequest
HomeWebsite APIDashboard API
HomeWebsite APIDashboard API
  1. Orders

Create order

POST
/admin/v1/orders
API key ability: orders:write.

Request

Authorization
Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201
application/json
Headers

Bodyapplication/json

🟠401AuthenticationException
🟠422ValidationException
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://dashboard.shantaweb.com/admin/v1/orders' \
--header 'Accept-Language;' \
--header 'X-Website-ID;' \
--header 'Idempotency-Key;' \
--header 'Content-Type: application/json' \
--data '{
    "items": [
        {
            "product_id": 0,
            "quantity": 1,
            "options": [
                0
            ],
            "price": 0
        }
    ],
    "customer_id": 0,
    "payment_method": "cash",
    "delivery_method": "shipping",
    "branch_id": 0,
    "shipping_company_id": 0,
    "note": "string",
    "address": "string",
    "street_name": "string",
    "building_name": "string",
    "apartment_number": "string",
    "nearest_landmark": "string",
    "postal_code": "string",
    "country_id": 0,
    "city_id": 0
}'
Response Response Example
201 - Example 1
{
    "status": 201,
    "success": true,
    "data": {
        "id": 0,
        "customer_id": 0,
        "status": "string",
        "shipping_status": "string",
        "payment_method": "string",
        "payment_status": "string",
        "delivery_method": "string",
        "source": "string",
        "subtotal": "string",
        "shipping_cost": "string",
        "extra_shipping_cost": "string",
        "tax_amount": "string",
        "extra_amount": "string",
        "extra_amount_name": "string",
        "cod_commission": "string",
        "custom_amount": "string",
        "discount": "string",
        "total": "string",
        "currency": "string",
        "coupon": "string",
        "tracking_number": "string",
        "can_cancel": true,
        "allow_open_package": true,
        "first_name": "string",
        "last_name": "string",
        "email": "string",
        "phone": "string",
        "country_id": 0,
        "city_id": 0,
        "street_name": "string",
        "building_name": "string",
        "apartment_number": "string",
        "nearest_landmark": "string",
        "postal_code": "string",
        "note": "string",
        "branch_id": 0,
        "shipping_company_id": 0,
        "created_at": "string",
        "updated_at": "string",
        "items": [
            {
                "id": 0,
                "order_id": 0,
                "product_id": 0,
                "title": "string",
                "image_url": "string",
                "quantity": 0,
                "price": "string",
                "tax_amount": "string",
                "total": "string",
                "currency": "string",
                "note": "string",
                "chosen_options": [
                    {
                        "option_id": 0,
                        "name": "string",
                        "value_id": 0,
                        "value": "string",
                        "price": "string",
                        "currency": "string"
                    }
                ],
                "created_at": "string",
                "updated_at": "string"
            }
        ],
        "shipping_company": {
            "id": 0,
            "name": "string"
        }
    },
    "meta": [
        null
    ]
}
Modified at 2026-10-25 03:06:51
Previous
List orders
Next
Get order
Built with