POST api/v{version}/deliveries/return

Prenota una reso con Fermo!Point (da Point o indirizzo fisico al Merchant).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

string

None.

Body Parameters

ApiRequestOfApiReturnRequest
NameDescriptionTypeAdditional information
data

ApiReturnRequest

Required

client_id

string

Required

auth_token

string

Required

ts

string

Required

Request Formats

application/json, text/json

Sample:
{
  "data": {
    "return_code": "sample string 1",
    "source_warehouse": "sample string 2",
    "source_point_id": 1,
    "source_name": "sample string 3",
    "source_address": {
      "s": "sample string 1",
      "e": "sample string 2",
      "c": "sample string 3",
      "l": "sample string 4",
      "p": "sample string 5",
      "d": "sample string 6"
    },
    "source_contact": "sample string 4",
    "source_phone_number": "sample string 5",
    "destination_warehouse": "sample string 6",
    "destination_point_id": 1,
    "destination_address": {
      "s": "sample string 1",
      "e": "sample string 2",
      "c": "sample string 3",
      "l": "sample string 4",
      "p": "sample string 5",
      "d": "sample string 6"
    },
    "pickup_ticketId": "sample string 7",
    "merchant_id": "sample string 8",
    "merchant_notes": "sample string 9",
    "fullname": "sample string 10",
    "email": "sample string 11",
    "phone_number": "sample string 12",
    "shipping_insurance": true,
    "shipping_insurance_amount": 1.0,
    "shipping_insurance_is_old": true,
    "packs": [
      {
        "notes": "sample string 1",
        "barcode_text": "sample string 2",
        "barcode_code128_base64": "sample string 3",
        "weight": 4.1,
        "size1": 5,
        "size2": 6,
        "size3": 7
      },
      {
        "notes": "sample string 1",
        "barcode_text": "sample string 2",
        "barcode_code128_base64": "sample string 3",
        "weight": 4.1,
        "size1": 5,
        "size2": 6,
        "size3": 7
      }
    ],
    "custom_label_url": [
      {
        "type": "sample string 1",
        "url": "sample string 2"
      },
      {
        "type": "sample string 1",
        "url": "sample string 2"
      }
    ]
  },
  "client_id": "sample string 1",
  "auth_token": "sample string 2",
  "ts": "sample string 3"
}

Response Information

Resource Description

ApiDelivery aggiornata

ApiDelivery
NameDescriptionTypeAdditional information
deliveryId

string

None.

merchant_id

string

Required

Max length: 100

merchant_notes

string

Max length: 100

source_point_id

integer

None.

source_name

string

None.

source_address

ApiAddress

None.

source_contact

string

None.

source_phone_number

string

None.

destination_point_id

integer

None.

destination_name

string

None.

destination_address

ApiAddress

None.

destination_contact

string

None.

destination_phone_number

string

None.

fullname

string

Required

String length: inclusive between 0 and 255

email

string

Required

Matching regular expression pattern: (?:.{1,64}@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?)

Max length: 255

phone_number

string

Data type: PhoneNumber

Matching regular expression pattern: ^[0-9- ]*$

Max length: 20

packs

Collection of ApiPack

None.

weight

decimal number

None.

price

decimal number

None.

shipping_insurance

boolean

None.

state

string

None.

pickup_order

ApiOrder

None.

notes

Collection of ApiNote

None.

last_update

date

None.

shipping_label_url

string

None.

shipping_label_urls

Collection of ApiLabelUrl

None.

Response Formats

application/json, text/json

Sample:
{
  "deliveryId": "SA234FB123456",
  "merchant_id": "201812060001",
  "merchant_notes": "Ordine n.1",
  "source_point_id": null,
  "source_name": null,
  "source_address": null,
  "source_contact": null,
  "source_phone_number": null,
  "destination_point_id": 1,
  "destination_name": "Negozio Fermo!Point - Milano",
  "destination_address": {
    "s": "Corso Buenos Aires 100",
    "e": null,
    "c": "Milano",
    "l": null,
    "p": "20124",
    "d": "MI"
  },
  "destination_contact": "Nome Negoziante",
  "destination_phone_number": "02 111 111 11",
  "fullname": "Ospite Test Ecommerce",
  "email": "utente@email.com",
  "phone_number": "333 8778902",
  "packs": [
    {
      "notes": "nota pacco",
      "barcode_text": null,
      "barcode_code128_base64": null,
      "weight": 2.0,
      "size1": 10,
      "size2": 10,
      "size3": 10
    },
    {
      "notes": "nota pacco",
      "barcode_text": null,
      "barcode_code128_base64": null,
      "weight": 2.0,
      "size1": 10,
      "size2": 10,
      "size3": 10
    },
    {
      "notes": "nota pacco",
      "barcode_text": null,
      "barcode_code128_base64": null,
      "weight": 2.0,
      "size1": 10,
      "size2": 10,
      "size3": 10
    }
  ],
  "weight": 6.0,
  "price": 9.9,
  "shipping_insurance": false,
  "state": "InDelivery",
  "pickup_order": {
    "ticketId": "A23AA33A1221",
    "merchant_id": "201812060001",
    "merchant_notes": "Ordine n.1",
    "point_id": 1,
    "nickname": "guest",
    "email": "utente@email.com",
    "phone_number": "333 8778902",
    "state": "Booked",
    "notes": [
      {
        "date": "2018-12-06T15:07:51.2608Z",
        "note": "Nota sull'ordine"
      },
      {
        "date": "2018-12-06T15:07:51.2608Z",
        "note": "Nota sull'ordine"
      }
    ],
    "last_update": "2018-12-06T15:07:51.292Z"
  },
  "notes": [
    {
      "date": "2018-12-06T15:07:51.2608Z",
      "note": "Nota sull'ordine"
    },
    {
      "date": "2018-12-06T15:07:51.2608Z",
      "note": "Nota sull'ordine"
    }
  ],
  "last_update": "2018-12-06T15:07:51.292Z",
  "shipping_label_url": "https://console.sandbox.fermopoint.it/get-shipping-label.aspx?id=0&deliveryId=A23AA33A1221&token=vcFH8xrhwQvoJ63a1LqYOtFkZxK%2bBomsIFvZBm62Hi12WXeTMEQuL2GmKYTij9IaxLdIV2SUW1Bhwsxhi8V8zg",
  "shipping_label_urls": [
    {
      "type": "pdf",
      "url": "http://label.spedizioniere.it/label/012345679?type=pdf"
    },
    {
      "type": "zpl",
      "url": "http://label.spedizioniere.it/label/012345679?type=zpl"
    },
    {
      "type": "jpg",
      "url": "http://label.spedizioniere.it/label/012345679?type=jpg"
    }
  ]
}