Stavy objednávek

pro práci se stavy objednávky lze využívat webhooky
typy stavů Homecredit se zakládají automaticky při zapnutí doplňku Homecredit
více o stavech objednávek v Upgates e-shopech naleznete zde.

Seznam stavů

GET

/api/v2/order-statuses

Seznam stavů › query Parameters

type

OrderStatusType · enum

typ stavu objednávky:

Received - přijatá
Canceled - stornovaná
Sent - odeslaná
PaymentSuccessful - platba úspěšná
PaymentFailed - platba selhala
PaymentCanceled - platba zrušena
PaymentInProcess - platba probíhá
Unresolved - nedořešená
Custom - vlastní
HomecreditProcessing - Homecredit - Probíhá
HomecreditRejected - Homecredit - Zamítnuto
HomecreditApproved - Homecredit - Schváleno
HomecreditReadyToShip - Homecredit - Připraveno k odeslání
HomecreditSent - Homecredit - Odesláno
HomecreditDelivered - Homecredit - Doručeno
HomecreditPaid - Homecredit - Zaplaceno
HomecreditCanceled - Homecredit - Zrušeno

Enum values:

Received

Canceled

Sent

PaymentSuccessful

PaymentFailed

PaymentCanceled

PaymentInProcess

Unresolved

Seznam stavů › Responses

200

object[]

pole objektů se stavy

Aktualizace stavu

PUT

/api/v2/order-statuses

Aktualizace existujícího stavu objednávky.

Aktualizace stavu › Request Body

id

integer · required

ID existujícího stavu

object[] · required

lokalizované názvy stavu

color

string

barva stavu v HTML HEX formátu

mark_resolved_yn

boolean

příznak označovat objednávku jako vyřešenou

mark_paid_yn

boolean

příznak označovat objednávku jako zaplacenou

Aktualizace stavu › Responses

200

object

výsledek aktualizace stavu

PUT/api/v2/order-statuses

curl --request PUT \
  --url /api/v2/order-statuses \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 0,
  "color": "color",
  "descriptions": [
    {
      "language_id": "cz",
      "name": "name"
    }
  ],
  "mark_resolved_yn": true,
  "mark_paid_yn": true
}
'

shell

Example Request Body

{
  "id": 0,
  "color": "color",
  "descriptions": [
    {
      "language_id": "cz",
      "name": "name"
    }
  ],
  "mark_resolved_yn": true,
  "mark_paid_yn": true
}

json

Example Responses

{
  "order_status": {
    "id": 0,
    "updated_yn": true,
    "messages": [
      {
        "object": "object",
        "property": "property",
        "message": "message",
        "level": "info"
      }
    ]
  }
}

json

application/json

Vytvoření stavu

POST

/api/v2/order-statuses

Vytvoření nového stavu objednávky. Typ se u nově založeného stavu dává vždy vlastní (custom).

Vytvoření stavu › Request Body

object[] · required

lokalizované názvy stavu

color

string

barva stavu v HTML HEX formátu

mark_resolved_yn

boolean

příznak označovat objednávku jako vyřešenou.

Default: false

mark_paid_yn

boolean

příznak označovat objednávku jako zaplacenou.

Default: false

Vytvoření stavu › Responses

200

object

výsledek vytvoření stavu

POST/api/v2/order-statuses

curl --request POST \
  --url /api/v2/order-statuses \
  --header 'Content-Type: application/json' \
  --data '
{
  "color": "color",
  "descriptions": [
    {
      "language_id": "cz",
      "name": "name"
    }
  ],
  "mark_resolved_yn": false,
  "mark_paid_yn": false
}
'

shell

Example Request Body

{
  "color": "color",
  "descriptions": [
    {
      "language_id": "cz",
      "name": "name"
    }
  ],
  "mark_resolved_yn": false,
  "mark_paid_yn": false
}

json

Example Responses

{
  "order_status": {
    "id": 0,
    "created_yn": true,
    "messages": [
      {
        "object": "object",
        "property": "property",
        "message": "message",
        "level": "info"
      }
    ]
  }
}

json

application/json

Detail stavu objednávky

GET

/api/v2/order-statuses/{id}

Detail stavu objednávky › path Parameters

id

string · required

ID stavu

Detail stavu objednávky › Responses

200

object[]

pole objektů se stavy

Smazání stavu

DELETE

/api/v2/order-statuses/{id}

Smazání stavu › path Parameters

id

integer · required

ID stavu

Smazání stavu › Responses

200

object

výsledek smazání stavu

Soubory Štítky

Seznam stavů

GET

/api/v2/order-statuses

Seznam stavů › query Parameters

type

OrderStatusType · enum

typ stavu objednávky:

Received - přijatá
Canceled - stornovaná
Sent - odeslaná
PaymentSuccessful - platba úspěšná
PaymentFailed - platba selhala
PaymentCanceled - platba zrušena
PaymentInProcess - platba probíhá
Unresolved - nedořešená
Custom - vlastní
HomecreditProcessing - Homecredit - Probíhá
HomecreditRejected - Homecredit - Zamítnuto
HomecreditApproved - Homecredit - Schváleno
HomecreditReadyToShip - Homecredit - Připraveno k odeslání
HomecreditSent - Homecredit - Odesláno
HomecreditDelivered - Homecredit - Doručeno
HomecreditPaid - Homecredit - Zaplaceno
HomecreditCanceled - Homecredit - Zrušeno

Enum values:

Received

Canceled

Sent

PaymentSuccessful

PaymentFailed

PaymentCanceled

PaymentInProcess

Unresolved

Seznam stavů › Responses

200

object[]

pole objektů se stavy

Aktualizace stavu

PUT

/api/v2/order-statuses

Aktualizace existujícího stavu objednávky.

Aktualizace stavu › Request Body

id

integer · required

ID existujícího stavu

object[] · required

lokalizované názvy stavu

color

string

barva stavu v HTML HEX formátu

mark_resolved_yn

boolean

příznak označovat objednávku jako vyřešenou

mark_paid_yn

boolean

příznak označovat objednávku jako zaplacenou

Aktualizace stavu › Responses

200

object

výsledek aktualizace stavu

Vytvoření stavu

POST

/api/v2/order-statuses

Vytvoření nového stavu objednávky. Typ se u nově založeného stavu dává vždy vlastní (custom).

Vytvoření stavu › Request Body

object[] · required

lokalizované názvy stavu

color

string

barva stavu v HTML HEX formátu

mark_resolved_yn

boolean

příznak označovat objednávku jako vyřešenou.

Default: false

mark_paid_yn

boolean

příznak označovat objednávku jako zaplacenou.

Default: false

Vytvoření stavu › Responses

200

object

výsledek vytvoření stavu