创建订单

开发中

vgs_dev

https://dapi.visageniusglobal.com

POST

/openvisa/order_add

一、变更说明

变更内容	变更人	变更时间
新增material_upload_type	周建成	2023-11-21
修改order_express_address 为可选项（创建或者支付订单有一次提交即可）	周建成	2024-08-26

二、接口说明

1、material_upload_type 为0 表示资料分开上传，则申请人提交资料需要调用applicant_material_submit接口，更新申请人资料需要调用applicant_material_resubmit，不传或者传1表示资料以压缩包的形式上传，申请人提交资料需调用applicant_material_add接口，更新申请人资料需要调用applicant_material_update接口。

三、鉴权

见:商品列表查询

请求参数

Header 参数

X-Date

string

可选

示例值:

X-Appid

string

可选

示例值:

Authorization

string

可选

示例值:

Body 参数application/json

material_upload_type

integer

资料提交方式

可选

不传默认1-压缩包方式提交 0-完全匹配提交

product_id

integer

商品id

必需

contact_number

string

联系人电话

必需

contact_name

string

联系人姓名

必需

pay_amount

integer

订单支付总金额

必需

以分为单位

depart_date

string

出行日期

必需

effect_date

string

签证生效日期

可选

越南、俄罗斯等国家需选择签证生效日期，当/product_query接口返回need_effect_date=1时必填。

order_express_address

object

订单回寄地址

可选

如商品详情中的need_return_material=1，需在创建订单或者订单支付时填写

addressee

string

收件人

必需

mobile_phone

string

手机号码

必需

province_code

string

省份code

必需

city_code

string

城市code

必需

county_code

string

区code

必需

没有区时，默认传0

detail_address

string

详细地址

必需

applicant_set

array [object {3}]

必需

identity_id

enum<integer>

身份id

必需

0在职人员 1自由职业者 2退休人员 3在校学生 4学龄前儿童 5通用身份

枚举值:

012345

applicant_name

string

申请人姓名

可选

applicant_no

string

第三方申请人编号

必需

示例

{
    "depart_date": "2023-11-20",
    "product_id": 10747,
    "pay_amount": 20,
    "contact_number": "13333333333",
    "contact_name": "张三",
    "applicant_set": [
        {
            "identity_id": 0,
            "applicant_no": "test12344",
            "applicant_name": "测试"

        }
    ],
    "order_express_address": {
        "addressee": "阿信",
        "detail_address": "北投",
        "county_code": "420103",
        "city_code": "420100",
        "province_code": "420000",
        "mobile_phone": "15071097990"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://dapi.visageniusglobal.com/openvisa/order_add' \
--header 'X-Date: ' \
--header 'X-Appid: ' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "depart_date": "2023-11-20",
    "product_id": 10747,
    "pay_amount": 20,
    "contact_number": "13333333333",
    "contact_name": "张三",
    "applicant_set": [
        {
            "identity_id": 0,
            "applicant_no": "test12344",
            "applicant_name": "测试"

        }
    ],
    "order_express_address": {
        "addressee": "阿信",
        "detail_address": "北投",
        "county_code": "420103",
        "city_code": "420100",
        "province_code": "420000",
        "mobile_phone": "15071097990"
    }
}'

返回响应

🟢200成功

application/json

Body

0成功，其余失败

ret

integer

描述信息

必需

ret非0时，显示为错误描述信息

msg

string

必需

body

object

必需

order_id

integer

订单id

必需

pay_status

enum<integer>

支付状态

必需

0,待支付 1,已支付 2,已退款

枚举值:

012

order_status

enum<integer>

订单状态

必需

0,已取消 1,待上传资料 2,待填写申请表 3,待支付 4,待邮寄资料 5,办理中 6,已发货 7,待评价 8,已完成 9,已删除 10,待选择赴馆日期

枚举值:

012345678910

applicant_set

array [object {4}]

必需

{"ret":0,"msg":"ok","body":{"pay_status":0,"applicant_set":[{"applicant_no":"test12344","applicant_name":"测试","applicant_id":34736,"applicant_status":1}],"order_status":1,"order_id":1000012388}}

🟢200接口异常

🟠400参数不正确

🔴503服务异常

商品状态变更回调通知

订单支付

创建订单

一、变更说明#

二、接口说明#

三、鉴权#

请求参数

示例代码

返回响应

一、变更说明

二、接口说明

三、鉴权