Objednávky - přílohy

existují dva druhy příloh, soubor a odkaz
více o přílohách v objednávkách v Upgates e-shopech najdete zde.

Přidání souboru

POST

/api/v2/orders/{order_number}/file

Poslání obsahu souboru přes form-data.

Přidání souboru › path Parameters

order_number

string · required

Číslo objednávky

Přidání souboru › Request Body

file

string · binary · required

obsah souboru

file_name

string

název souboru

code

string

kód přílohy

Přidání souboru › Responses

200

id

integer

ID přílohy

object

informace o souboru

inserted_yn

boolean

informace o úspěšném vytvoření položky

object[]

chybové zprávy

Přidání odkazů

POST

/api/v2/orders/{order_number}/urls

Přidání odkazů › path Parameters

order_number

string · required

Číslo objednávky

Přidání odkazů › Request Body

object[] · required

pole objektů s daty přílohy

Přidání odkazů › Responses

200

object[]

chybové zprávy

POST/api/v2/orders/{order_number}/urls

curl --request POST \
  --url /api/v2/orders/:order_number/urls \
  --header 'Content-Type: application/json' \
  --data '
{
  "urls": [
    {
      "name": "name",
      "url": "https://www.example.com/path/to/resource",
      "code": "code"
    }
  ]
}
'

shell

Example Request Body

{
  "urls": [
    {
      "name": "name",
      "url": "https://www.example.com/path/to/resource",
      "code": "code"
    }
  ]
}

json

Example Responses

{
  "urls": [
    {
      "id": 0,
      "name": "name",
      "url": "https://www.example.com/path/to/resource",
      "code": "code",
      "inserted_yn": true,
      "messages": [
        {
          "object": "object",
          "property": "property",
          "message": "message",
          "level": "info"
        }
      ]
    }
  ],
  "messages": [
    {
      "object": "object",
      "property": "property",
      "message": "message",
      "level": "info"
    }
  ]
}

json

application/json

Smazání přílohy

DELETE

/api/v2/orders/{order_number}/attachments

Smazání přílohy › path Parameters

order_number

string · required

Číslo objednávky

Smazání přílohy › query Parameters

ids

QueryParameterArrayInt

ID přílohy objednávky oddělené středníkem ; nebo jako pole

Smazání přílohy › Responses

200

object[]

Objednávky - historie Parametry

Přidání souboru

POST

/api/v2/orders/{order_number}/file

Poslání obsahu souboru přes form-data.

Přidání souboru › path Parameters

order_number

string · required

Číslo objednávky

Přidání souboru › Request Body

file

string · binary · required

obsah souboru

file_name

string

název souboru

code

string

kód přílohy

Přidání souboru › Responses

200

id

integer

ID přílohy

object

informace o souboru

inserted_yn

boolean

informace o úspěšném vytvoření položky

object[]

chybové zprávy

Přidání odkazů

POST

/api/v2/orders/{order_number}/urls

Přidání odkazů › path Parameters

order_number

string · required

Číslo objednávky

Přidání odkazů › Request Body

object[] · required

pole objektů s daty přílohy

Přidání odkazů › Responses

200

object[]

chybové zprávy

Smazání přílohy

DELETE

/api/v2/orders/{order_number}/attachments

Smazání přílohy › path Parameters

order_number

string · required

Číslo objednávky

Smazání přílohy › query Parameters

ids

QueryParameterArrayInt

ID přílohy objednávky oddělené středníkem ; nebo jako pole

Smazání přílohy › Responses

200

object[]