SupplierConnect Gateway API

GetGatewayPacketStatus

Retrieve GatewayPacket status

The following routes are available for this service:
GET	/api/packet/getstatus/{GatewayPacketId}

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GatewayPacketStatus:
    gateway_packet_id: Optional[str] = None
    communication_status_id: Optional[str] = None
    communication_status: Optional[str] = None
    status_message: Optional[str] = None
    payload_finalised: Optional[bool] = None
    alternate_key: Optional[str] = None


# @Api(Description="Retrieve GatewayPacket status")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetGatewayPacketStatus:
    """
    Retrieve GatewayPacket status
    """

    gateway_packet_id: Optional[str] = None

Python GetGatewayPacketStatus DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/packet/getstatus/{GatewayPacketId} HTTP/1.1 
Host: production-eros-gateway-api-supplierconnect.azurewebsites.net 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CommunicationStatus: String,
	StatusMessage: String,
	PayloadFinalised: False,
	AlternateKey: String
}