def post(self, request: Request):
"""
Create a new customs declaration.
"""
customs = SerializerDecorator[CustomsSerializer](
data=request.data, context=request).save().instance
return Response(Customs(customs).data, status=status.HTTP_201_CREATED)
def get(self, request: Request):
"""
Retrieve all stored customs declarations.
"""
customs_info = models.Customs.access_by(request).filter(shipment=None)
serializer = Customs(customs_info, many=True)
response = self.paginate_queryset(serializer.data)
return self.get_paginated_response(response)
def post(self, request: Request, pk: str):
"""
Add a customs commodity.
"""
customs = models.Customs.access_by(request).get(pk=pk)
shipment = customs.shipment_set.first()
if shipment.status == ShipmentStatus.purchased.value:
raise PurplShipApiException(
"The associated shipment is already 'purchased'",
status_code=status.HTTP_409_CONFLICT,
code='state_error')
commodity = SerializerDecorator[CommoditySerializer](
data=request.data, context=request).save().instance
customs.commodities.add(commodity)
return Response(Customs(commodity.customs_set.first()).data)
class CustomsCommodities(APIView):
@swagger_auto_schema(tags=['Customs'],
operation_id=f"{ENDPOINT_ID}add_commodity",
operation_summary="Add a commodity",
responses={
200: Customs(),
400: ErrorResponse()
},
request_body=CommodityData(),
code_examples=[{
'lang':
'bash',
'source':
'''
curl --request POST \\
--url /v1/customs_info/<CUSTOMS_INFO_ID>/commodities \\
--header 'Authorization: Token <API_KEY>' \\
--header 'Content-Type: application/json' \\
--data '{
"weight": 1,
"weight_unit": "KG",
"quantity": 1,
"sku": "XXXXX0000123",
"value_amount": 25,
"value_currency": "USD",
"origin_country": "CA"
}'
'''
}])
def post(self, request: Request, pk: str):
"""
Add a customs commodity.
"""
customs = models.Customs.access_by(request).get(pk=pk)
shipment = customs.shipment_set.first()
if shipment.status == ShipmentStatus.purchased.value:
raise PurplShipApiException(
"The associated shipment is already 'purchased'",
status_code=status.HTTP_409_CONFLICT,
code='state_error')
commodity = SerializerDecorator[CommoditySerializer](
data=request.data, context=request).save().instance
customs.commodities.add(commodity)
return Response(Customs(commodity.customs_set.first()).data)
def patch(self, request: Request, pk: str):
"""
modify an existing customs declaration.
"""
customs = models.Customs.access_by(request).get(pk=pk)
shipment = customs.shipment_set.first()
if shipment is not None and shipment.status == ShipmentStatus.purchased.value:
raise PurplShipApiException(
"The shipment related to this customs info has been 'purchased' and can no longer be modified",
status_code=status.HTTP_409_CONFLICT,
code='state_error')
SerializerDecorator[CustomsSerializer](customs,
data=request.data,
context=request).save()
reset_related_shipment_rates(shipment)
return Response(Customs(customs).data)
class CustomsList(GenericAPIView):
queryset = models.Customs.objects
pagination_class = type('CustomPagination', (LimitOffsetPagination, ),
dict(default_limit=20))
@swagger_auto_schema(tags=['Customs'],
operation_id=f"{ENDPOINT_ID}list",
operation_summary="List all customs info",
responses={
200: CustomsInfoList(),
400: ErrorResponse()
},
code_examples=[{
'lang':
'bash',
'source':
'''
curl --request GET \\
--url '/v1/customs_info' \\
--header 'Authorization: Token <API_KEY>'
'''
}])
def get(self, request: Request):
"""
Retrieve all stored customs declarations.
"""
customs_info = models.Customs.access_by(request).filter(shipment=None)
serializer = Customs(customs_info, many=True)
response = self.paginate_queryset(serializer.data)
return self.get_paginated_response(response)
@swagger_auto_schema(tags=['Customs'],
operation_id=f"{ENDPOINT_ID}create",
operation_summary="Create a customs info",
request_body=CustomsData(),
responses={
200: Customs(),
400: ErrorResponse()
},
code_examples=[{
'lang':
'bash',
'source':
'''
curl --request POST \\
--url /v1/customs_info \\
--header 'Authorization: Token <API_KEY>' \\
--header 'Content-Type: application/json' \\
--data '{
"content_type": "merchandise",
"incoterm": "DDU",
"commodities": [
{
"weight": 2,
"weight_unit": "KG",
"quantity": 1,
"sku": "XXXXX0000123",
"value_amount": 30,
"value_currency": "USD",
"origin_country": "JM"
}
],
"duty": {
"paid_by": "recipient",
"currency": "USD",
"declared_value": 60,
},
"certify": true,
"signer": "Kex",
}'
'''
}])
def post(self, request: Request):
"""
Create a new customs declaration.
"""
customs = SerializerDecorator[CustomsSerializer](
data=request.data, context=request).save().instance
return Response(Customs(customs).data, status=status.HTTP_201_CREATED)
def get(self, request: Request, pk: str):
"""
Retrieve customs declaration.
"""
address = models.Customs.access_by(request).get(pk=pk)
return Response(Customs(address).data)
class CustomsDetail(APIView):
@swagger_auto_schema(tags=['Customs'],
operation_id=f"{ENDPOINT_ID}retrieve",
operation_summary="Retrieve a customs info",
responses={
200: Customs(),
400: ErrorResponse()
},
code_examples=[{
'lang':
'bash',
'source':
'''
curl --request GET \\
--url /v1/customs_info/<CUSTOMS_INFO_ID> \\
--header 'Authorization: Token <API_KEY>'
'''
}])
def get(self, request: Request, pk: str):
"""
Retrieve customs declaration.
"""
address = models.Customs.access_by(request).get(pk=pk)
return Response(Customs(address).data)
@swagger_auto_schema(tags=['Customs'],
operation_id=f"{ENDPOINT_ID}update",
operation_summary="Update a customs info",
request_body=CustomsData(),
responses={
200: Customs(),
400: ErrorResponse()
},
code_examples=[{
'lang':
'bash',
'source':
'''
curl --request PATCH \\
--url /v1/customs_info/<CUSTOMS_INFO_ID> \\
--header 'Authorization: Token <API_KEY>' \\
--header 'Content-Type: application/json' \\
--data '{
"content_type": "merchandise",
"duty": {
"paid_by": "recipient",
"currency": "CAD",
"declared_value": 100,
}
}'
'''
}])
def patch(self, request: Request, pk: str):
"""
modify an existing customs declaration.
"""
customs = models.Customs.access_by(request).get(pk=pk)
shipment = customs.shipment_set.first()
if shipment is not None and shipment.status == ShipmentStatus.purchased.value:
raise PurplShipApiException(
"The shipment related to this customs info has been 'purchased' and can no longer be modified",
status_code=status.HTTP_409_CONFLICT,
code='state_error')
SerializerDecorator[CustomsSerializer](customs,
data=request.data,
context=request).save()
reset_related_shipment_rates(shipment)
return Response(Customs(customs).data)
@swagger_auto_schema(tags=['Customs'],
operation_id=f"{ENDPOINT_ID}discard",
operation_summary="Discard a customs info",
responses={
200: Operation(),
400: ErrorResponse()
},
code_examples=[{
'lang':
'bash',
'source':
'''
curl --request DELETE \\
--url /v1/customs_info/<CUSTOMS_INFO_ID> \\
--header 'Authorization: Token <API_KEY>'
'''
}])
def delete(self, request: Request, pk: str):
"""
Discard a customs declaration.
"""
customs = models.Customs.access_by(request).get(pk=pk)
shipment = customs.shipment_set.first()
if shipment is not None and shipment.status == ShipmentStatus.purchased.value:
raise PurplShipApiException(
"The shipment related to this customs info has been 'purchased' and cannot be discarded",
status_code=status.HTTP_409_CONFLICT,
code='state_error')
customs.delete(keep_parents=True)
shipment.customs = None
serializer = Operation(
dict(operation="Discard customs info", success=True))
reset_related_shipment_rates(shipment)
return Response(serializer.data)