新建销售退单

新建一笔销售退单资料

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

clientId

string

clientId

必需

posTerminalId

string

必需

posTerminalId

storeId

string

storeId

必需

userId

string

userId

必需

Header 参数

Authorization

string

必需

Body 参数application/json

新建销售退单

amt

number <double>

销售金额（优惠前）

可选

balance

number <double>

尾款

可选

cancel_time

string <date-time>

订单取消时间

可选

cashier_id

string

收银员ID

可选

cashier_name

string

收银员姓名

可选

channel

enum<string>

渠道

可选

枚举值:

CMCESHOPPOSQR_SCANKIOSKVEM

client_id

string

商户Id

可选

complete_time

string <date-time>

订单完成时间

可选

complete_user_id

string

完成用户ID

可选

customer_id

string

顾客ID

可选

deleted

boolean

已删除

可选

deposit

number <double>

订金

可选

disc

number <double>

优惠金额

可选

excess

number <double>

溢收

可选

free

boolean

免单

可选

items

array[object (PosRefundOrderItemVO) {42}]

商品明细

可选

amt

number <double>

销售金额（优惠前）

可选

authorizer_id

string

折扣授权人ID

可选

authorizer_name

string

折扣授权人姓名

可选

balance

number <double>

尾款

可选

barcode

string

商品条码

可选

client_merchandise_id

string

商家商品Id

可选

client_sku_id

string

商家SKU ID

可选

combo_items

array[object (PosRefundOrderComboVO) {4}]

套餐明细

可选

combo_markup

number <double>

套餐加价金额

可选

coupon_share

array[object (PosRefundOrderItemCouponVO) {11}]

券优惠分摊

可选

delivery

boolean

已发货

可选

deposit

number <double>

订金

可选

disc

number <double>

优惠金额

可选

disc_share

array[object (PosRefundOrderItemDiscVO) {8}]

活动分摊

可选

douyin

boolean

抖音兑换

可选

douyin_verify_order_id

string

抖音核销订单ID

可选

excess

number <double>

溢收

可选

string

明细Id

可选

ingredient_amt

number <double>

加料金额

可选

item_nos

array[object (PosRefundOrderItemNoVO) {6}]

卡/券号码

可选

item_value

number <double>

面额/折扣率

可选

memo

string

商品备注

可选

merchandise_code

string

商品编码

可选

merchandise_id

string

商品Id

可选

merchandise_name

string

商品品名

可选

minus_change

number <double>

抹零

可选

origin_item_id

string

原销售明细ID

可选

payable

number <double>

应付金额（优惠后）

可选

piece

integer <int32>

件数

可选

point_share

object (PosRefundOrderItemPointVO)

积分抵扣

可选

preorder

boolean

预定

可选

price

number <double>

零售价

可选

props

array[object (PosRefundOrderPropVO) {3}]

属性

可选

qty

number <double>

数量

可选

sku_id

string

单品Id

可选

sku_name

string

单品名称

可选

specs

array[object (PosRefundOrderSpecVO) {3}]

规格

可选

thumbnail

string

商品缩略图

可选

thumbnail_url

string

商品缩略图链接

可选

total_amt

number <double>

销售金额（优惠后）

可选

type

enum<string>

明细类型

可选

枚举值:

MERCHCOMBOCARDCOUPON

unit

string

单位

可选

member_id

string

会员ID

可选

member_mobile

string

会员手机号

可选

member_name

string

会员姓名

可选

memo

string

备注

可选

minus_change

number <double>

抹零

可选

open_seats

integer <int32>

开台人数

可选

origin_order_id

string

原销售订单ID

可选

pay_state

enum<string>

支付状态

可选

枚举值:

NONEPARTIALALL

payable

number <double>

应付金额

可选

piece

integer <int32>

件数

可选

platform

enum<string>

平台

可选

枚举值:

WEBWX_MPALIPAY_MPDOUYIN_MPTERMINAL

sales_asst_id

string

导购ID

可选

sales_asst_name

string

导购姓名

可选

seats

string

座位数

可选

shift_code

string

班次号

可选

shift_id

string

班次ID

可选

shift_name

string

班次名

可选

spot

number <double>

全款

可选

state

enum<string>

订单状态

可选

枚举值:

OPENORDEREDCONFIRMEDREADYDELIVERINGCOMPLETEDCANCELCLOSED

store_code

string

门店编号

可选

store_id

string

门店ID

可选

store_name

string

门店名

可选

table_id

string

桌台ID

可选

table_name

string

桌台名称

可选

takeout_store_code

string

取货门店编号

可选

takeout_store_id

string

取货门店ID

可选

takeout_store_name

string

取货门店名

可选

terminal_code

string

终端号

可选

terminal_id

string

终端ID

可选

terminal_name

string

终端名

可选

total_amt

number <double>

销售金额（优惠后）

可选

user_id

string

用户Id

可选

示例

{
  "amt": 0,
  "balance": 0,
  "cancel_time": "2019-08-24T14:15:22Z",
  "cashier_id": "string",
  "cashier_name": "string",
  "channel": "CMC",
  "client_id": "string",
  "complete_time": "2019-08-24T14:15:22Z",
  "complete_user_id": "string",
  "customer_id": "string",
  "deleted": true,
  "deposit": 0,
  "disc": 0,
  "excess": 0,
  "free": true,
  "items": [
    {
      "amt": 0,
      "authorizer_id": "string",
      "authorizer_name": "string",
      "balance": 0,
      "barcode": "string",
      "client_merchandise_id": "string",
      "client_sku_id": "string",
      "combo_items": [
        {
          "group": "string",
          "group_qty": 0,
          "required": true,
          "skus": [
            {
              "amt": 0,
              "barcode": "string",
              "client_merchandise_id": "string",
              "client_sku_id": "string",
              "combo_markup": 0,
              "disc": 0,
              "excess": 0,
              "ingredient_amt": 0,
              "merchandise_code": "string",
              "merchandise_id": "string",
              "merchandise_name": "string",
              "minus_change": 0,
              "payable": 0,
              "piece": 0,
              "price": 0,
              "props": [
                {
                  "name": "string",
                  "price": 0,
                  "value": "string"
                }
              ],
              "qty": 0,
              "sku_id": "string",
              "sku_name": "string",
              "specs": [
                {
                  "name": "string",
                  "seq": 0,
                  "value": "string"
                }
              ],
              "thumbnail": "string",
              "total_amt": 0
            }
          ]
        }
      ],
      "combo_markup": 0,
      "coupon_share": [
        {
          "coupon_id": "string",
          "coupon_item_id": "string",
          "coupon_name": "string",
          "coupon_no": "string",
          "coupon_show_name": "string",
          "coupon_type": "BLANK",
          "disc": 0,
          "excess": 0,
          "physical": true,
          "reached_amt": 0,
          "reached_qty": 0
        }
      ],
      "delivery": true,
      "deposit": 0,
      "disc": 0,
      "disc_share": [
        {
          "disc": 0,
          "disc_id": "string",
          "disc_name": "string",
          "disc_rate": 0,
          "disc_value": 0,
          "reached_amt": 0,
          "reached_qty": 0,
          "type": "LIMIT_DISC"
        }
      ],
      "douyin": true,
      "douyin_verify_order_id": "string",
      "excess": 0,
      "id": "string",
      "ingredient_amt": 0,
      "item_nos": [
        {
          "end_no": "string",
          "end_no_id": "string",
          "id": "string",
          "qty": 0,
          "start_no": "string",
          "start_no_id": "string"
        }
      ],
      "item_value": 0,
      "memo": "string",
      "merchandise_code": "string",
      "merchandise_id": "string",
      "merchandise_name": "string",
      "minus_change": 0,
      "origin_item_id": "string",
      "payable": 0,
      "piece": 0,
      "point_share": {
        "point_amt": 0,
        "point_value": 0
      },
      "preorder": true,
      "price": 0,
      "props": [
        {
          "name": "string",
          "price": 0,
          "value": "string"
        }
      ],
      "qty": 0,
      "sku_id": "string",
      "sku_name": "string",
      "specs": [
        {
          "name": "string",
          "seq": 0,
          "value": "string"
        }
      ],
      "thumbnail": "string",
      "thumbnail_url": "string",
      "total_amt": 0,
      "type": "MERCH",
      "unit": "string"
    }
  ],
  "member_id": "string",
  "member_mobile": "string",
  "member_name": "string",
  "memo": "string",
  "minus_change": 0,
  "open_seats": 0,
  "origin_order_id": "string",
  "pay_state": "NONE",
  "payable": 0,
  "piece": 0,
  "platform": "WEB",
  "sales_asst_id": "string",
  "sales_asst_name": "string",
  "seats": "string",
  "shift_code": "string",
  "shift_id": "string",
  "shift_name": "string",
  "spot": 0,
  "state": "OPEN",
  "store_code": "string",
  "store_id": "string",
  "store_name": "string",
  "table_id": "string",
  "table_name": "string",
  "takeout_store_code": "string",
  "takeout_store_id": "string",
  "takeout_store_name": "string",
  "terminal_code": "string",
  "terminal_id": "string",
  "terminal_name": "string",
  "total_amt": 0,
  "user_id": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/pos/posCateringRefund/add?clientId=&posTerminalId=&storeId=&userId=' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amt": 0,
    "balance": 0,
    "cancel_time": "2019-08-24T14:15:22Z",
    "cashier_id": "string",
    "cashier_name": "string",
    "channel": "CMC",
    "client_id": "string",
    "complete_time": "2019-08-24T14:15:22Z",
    "complete_user_id": "string",
    "customer_id": "string",
    "deleted": true,
    "deposit": 0,
    "disc": 0,
    "excess": 0,
    "free": true,
    "items": [
        {
            "amt": 0,
            "authorizer_id": "string",
            "authorizer_name": "string",
            "balance": 0,
            "barcode": "string",
            "client_merchandise_id": "string",
            "client_sku_id": "string",
            "combo_items": [
                {
                    "group": "string",
                    "group_qty": 0,
                    "required": true,
                    "skus": [
                        {
                            "amt": 0,
                            "barcode": "string",
                            "client_merchandise_id": "string",
                            "client_sku_id": "string",
                            "combo_markup": 0,
                            "disc": 0,
                            "excess": 0,
                            "ingredient_amt": 0,
                            "merchandise_code": "string",
                            "merchandise_id": "string",
                            "merchandise_name": "string",
                            "minus_change": 0,
                            "payable": 0,
                            "piece": 0,
                            "price": 0,
                            "props": [
                                {
                                    "name": "string",
                                    "price": 0,
                                    "value": "string"
                                }
                            ],
                            "qty": 0,
                            "sku_id": "string",
                            "sku_name": "string",
                            "specs": [
                                {
                                    "name": "string",
                                    "seq": 0,
                                    "value": "string"
                                }
                            ],
                            "thumbnail": "string",
                            "total_amt": 0
                        }
                    ]
                }
            ],
            "combo_markup": 0,
            "coupon_share": [
                {
                    "coupon_id": "string",
                    "coupon_item_id": "string",
                    "coupon_name": "string",
                    "coupon_no": "string",
                    "coupon_show_name": "string",
                    "coupon_type": "BLANK",
                    "disc": 0,
                    "excess": 0,
                    "physical": true,
                    "reached_amt": 0,
                    "reached_qty": 0
                }
            ],
            "delivery": true,
            "deposit": 0,
            "disc": 0,
            "disc_share": [
                {
                    "disc": 0,
                    "disc_id": "string",
                    "disc_name": "string",
                    "disc_rate": 0,
                    "disc_value": 0,
                    "reached_amt": 0,
                    "reached_qty": 0,
                    "type": "LIMIT_DISC"
                }
            ],
            "douyin": true,
            "douyin_verify_order_id": "string",
            "excess": 0,
            "id": "string",
            "ingredient_amt": 0,
            "item_nos": [
                {
                    "end_no": "string",
                    "end_no_id": "string",
                    "id": "string",
                    "qty": 0,
                    "start_no": "string",
                    "start_no_id": "string"
                }
            ],
            "item_value": 0,
            "memo": "string",
            "merchandise_code": "string",
            "merchandise_id": "string",
            "merchandise_name": "string",
            "minus_change": 0,
            "origin_item_id": "string",
            "payable": 0,
            "piece": 0,
            "point_share": {
                "point_amt": 0,
                "point_value": 0
            },
            "preorder": true,
            "price": 0,
            "props": [
                {
                    "name": "string",
                    "price": 0,
                    "value": "string"
                }
            ],
            "qty": 0,
            "sku_id": "string",
            "sku_name": "string",
            "specs": [
                {
                    "name": "string",
                    "seq": 0,
                    "value": "string"
                }
            ],
            "thumbnail": "string",
            "thumbnail_url": "string",
            "total_amt": 0,
            "type": "MERCH",
            "unit": "string"
        }
    ],
    "member_id": "string",
    "member_mobile": "string",
    "member_name": "string",
    "memo": "string",
    "minus_change": 0,
    "open_seats": 0,
    "origin_order_id": "string",
    "pay_state": "NONE",
    "payable": 0,
    "piece": 0,
    "platform": "WEB",
    "sales_asst_id": "string",
    "sales_asst_name": "string",
    "seats": "string",
    "shift_code": "string",
    "shift_id": "string",
    "shift_name": "string",
    "spot": 0,
    "state": "OPEN",
    "store_code": "string",
    "store_id": "string",
    "store_name": "string",
    "table_id": "string",
    "table_name": "string",
    "takeout_store_code": "string",
    "takeout_store_id": "string",
    "takeout_store_name": "string",
    "terminal_code": "string",
    "terminal_id": "string",
    "terminal_name": "string",
    "total_amt": 0,
    "user_id": "string"
}'

返回响应

🟢200OK

application/json

Body

code

string

可选

data

object (PosRefundOrderVO)

可选

POS零售订单退单数据

amt

number <double>

销售金额（优惠前）

可选

balance

number <double>

尾款

可选

cancel_time

string <date-time>

订单取消时间

可选

cashier_id

string

收银员ID

可选

cashier_name

string

收银员姓名

可选

channel

enum<string>

渠道

可选

枚举值:

CMCESHOPPOSQR_SCANKIOSKVEM

client_id

string

商户

可选

complete_time

string <date-time>

订单完成时间

可选

complete_user_id

string

完成用户ID

可选

create_time

string <date-time>

创建时间

可选

creator

string

创建人Id

可选

creator_name

string

创建人姓名

可选

customer_id

string

顾客ID

可选

deleted

boolean

已删除

可选

deposit

number <double>

订金

可选

disc

number <double>

优惠金额

可选

edit_time

string <date-time>

最后修改时间

可选

editer

string

修改人Id

可选

editer_name

string

修改人姓名

可选

excess

number <double>

溢收

可选

free

boolean

免单

可选

string

可选

items

array[object (PosRefundOrderItemVO) {42}]

商品明细

可选

member_id

string

会员ID

可选

member_mobile

string

会员手机号

可选

member_name

string

会员姓名

可选

member_point

number <double>

会员本次积分

可选

member_post_point

number <double>

会员新积分

可选

member_pre_point

number <double>

会员原积分

可选

memo

string

备注

可选

minus_change

number <double>

抹零

可选

open_seats

integer <int32>

开台人数

可选

origin_order_id

string

原销售订单ID

可选

pay_state

enum<string>

支付状态

可选

枚举值:

NONEPARTIALALL

payable

number <double>

应付金额

可选

piece

integer <int32>

件数

可选

platform

enum<string>

平台

可选

枚举值:

WEBWX_MPALIPAY_MPDOUYIN_MPTERMINAL

print_times

integer <int32>

打印次数

可选

sales_asst_id

string

导购ID

可选

sales_asst_name

string

导购姓名

可选

seats

string

座位数

可选

shift_code

string

班次号

可选

shift_id

string

班次ID

可选

shift_name

string

班次名

可选

spot

number <double>

全款

可选

state

enum<string>

订单状态

可选

枚举值:

ORDEREDCOMPLETEDCLOSEDCANCEL

store_code

string

门店编号

可选

store_id

string

门店ID

可选

store_name

string

门店名

可选

table_id

string

桌台ID

可选

table_name

string

桌台名称

可选

takeout_store_code

string

取货门店编号

可选

takeout_store_id

string

取货门店ID

可选

takeout_store_name

string

取货门店名

可选

terminal_code

string

终端号

可选

terminal_id

string

终端ID

可选

terminal_name

string

终端名

可选

total_amt

number <double>

销售金额（优惠后）

可选

type

enum<string>

订单类型

可选

枚举值:

RETAILBOOKCATERINGESHOPSCM

message

string

可选

示例

{
  "code": "string",
  "data": {
    "amt": 0,
    "balance": 0,
    "cancel_time": "2019-08-24T14:15:22Z",
    "cashier_id": "string",
    "cashier_name": "string",
    "channel": "CMC",
    "client_id": "string",
    "complete_time": "2019-08-24T14:15:22Z",
    "complete_user_id": "string",
    "create_time": "2019-08-24T14:15:22Z",
    "creator": "string",
    "creator_name": "string",
    "customer_id": "string",
    "deleted": true,
    "deposit": 0,
    "disc": 0,
    "edit_time": "2019-08-24T14:15:22Z",
    "editer": "string",
    "editer_name": "string",
    "excess": 0,
    "free": true,
    "id": "string",
    "items": [
      {
        "amt": 0,
        "authorizer_id": "string",
        "authorizer_name": "string",
        "balance": 0,
        "barcode": "string",
        "client_merchandise_id": "string",
        "client_sku_id": "string",
        "combo_items": [
          {
            "group": "string",
            "group_qty": 0,
            "required": true,
            "skus": [
              {
                "amt": 0,
                "barcode": "string",
                "client_merchandise_id": "string",
                "client_sku_id": "string",
                "combo_markup": 0,
                "disc": 0,
                "excess": 0,
                "ingredient_amt": 0,
                "merchandise_code": "string",
                "merchandise_id": "string",
                "merchandise_name": "string",
                "minus_change": 0,
                "payable": 0,
                "piece": 0,
                "price": 0,
                "props": [
                  {
                    "name": "string",
                    "price": 0,
                    "value": "string"
                  }
                ],
                "qty": 0,
                "sku_id": "string",
                "sku_name": "string",
                "specs": [
                  {
                    "name": "string",
                    "seq": 0,
                    "value": "string"
                  }
                ],
                "thumbnail": "string",
                "total_amt": 0
              }
            ]
          }
        ],
        "combo_markup": 0,
        "coupon_share": [
          {
            "coupon_id": "string",
            "coupon_item_id": "string",
            "coupon_name": "string",
            "coupon_no": "string",
            "coupon_show_name": "string",
            "coupon_type": "BLANK",
            "disc": 0,
            "excess": 0,
            "physical": true,
            "reached_amt": 0,
            "reached_qty": 0
          }
        ],
        "delivery": true,
        "deposit": 0,
        "disc": 0,
        "disc_share": [
          {
            "disc": 0,
            "disc_id": "string",
            "disc_name": "string",
            "disc_rate": 0,
            "disc_value": 0,
            "reached_amt": 0,
            "reached_qty": 0,
            "type": "LIMIT_DISC"
          }
        ],
        "douyin": true,
        "douyin_verify_order_id": "string",
        "excess": 0,
        "id": "string",
        "ingredient_amt": 0,
        "item_nos": [
          {
            "end_no": "string",
            "end_no_id": "string",
            "id": "string",
            "qty": 0,
            "start_no": "string",
            "start_no_id": "string"
          }
        ],
        "item_value": 0,
        "memo": "string",
        "merchandise_code": "string",
        "merchandise_id": "string",
        "merchandise_name": "string",
        "minus_change": 0,
        "origin_item_id": "string",
        "payable": 0,
        "piece": 0,
        "point_share": {
          "point_amt": 0,
          "point_value": 0
        },
        "preorder": true,
        "price": 0,
        "props": [
          {
            "name": "string",
            "price": 0,
            "value": "string"
          }
        ],
        "qty": 0,
        "sku_id": "string",
        "sku_name": "string",
        "specs": [
          {
            "name": "string",
            "seq": 0,
            "value": "string"
          }
        ],
        "thumbnail": "string",
        "thumbnail_url": "string",
        "total_amt": 0,
        "type": "MERCH",
        "unit": "string"
      }
    ],
    "member_id": "string",
    "member_mobile": "string",
    "member_name": "string",
    "member_point": 0,
    "member_post_point": 0,
    "member_pre_point": 0,
    "memo": "string",
    "minus_change": 0,
    "open_seats": 0,
    "origin_order_id": "string",
    "pay_state": "NONE",
    "payable": 0,
    "piece": 0,
    "platform": "WEB",
    "print_times": 0,
    "sales_asst_id": "string",
    "sales_asst_name": "string",
    "seats": "string",
    "shift_code": "string",
    "shift_id": "string",
    "shift_name": "string",
    "spot": 0,
    "state": "ORDERED",
    "store_code": "string",
    "store_id": "string",
    "store_name": "string",
    "table_id": "string",
    "table_name": "string",
    "takeout_store_code": "string",
    "takeout_store_id": "string",
    "takeout_store_name": "string",
    "terminal_code": "string",
    "terminal_id": "string",
    "terminal_name": "string",
    "total_amt": 0,
    "type": "RETAIL"
  },
  "message": "string"
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found